NativeScript / NativeScript/nativescript-cli
Document all hooks and how to use them
未關閉
還沒有人認領這個 Issue。
docs
hooks
- 主要語言
- JavaScript
- 星號
- 1.1k
- 分支
- 204
- 平均合併
- 1 天 9 小時
- 30 天內合併 PR
- 8
描述
Did you verify this is a real problem by searching Stack Overflow and the other open issues in this repo?
Yes, the current hooks documentation does not describe all hooks and use-cases. Also the link in https://github.com/NativeScript/nativescript-cli/blob/master/README.md#extending-the-cli is broken.
Tell us about the problem
We need to document all hooks for CLI and how the plugins and users can get benefit of them.
Tasks:
- Fix the link in https://github.com/NativeScript/nativescript-cli/blob/master/README.md#extending-the-cli
- Document all hooks and when they are executed.
- Describe how to use the hooks and add examples.
- Add tests that verify the examples in the previous step work correctly and will not be broken in future release.
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
從 CLI README 的「Extending the CLI」章節及其中的失效連結開始。盤點各個 hook 及其執行點,然後記錄它們的用法,並為外掛程式和使用者提供範例。新增測試來執行文件中的範例,並確認它們仍能正常運作。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- javascript
- 領域
- cli, documentation
- Issue 類型
- 文件
- 難度
- 4/5
- 預估耗時
- 3-5 天
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100