NativeScript / NativeScript/nativescript-cli
Document all hooks and how to use them
オープン
まだ誰も着手していません。
docs
hooks
- 主要言語
- JavaScript
- スター
- 1.1k
- フォーク
- 204
- 平均マージ
- 1日 9時間
- マージ済み PR(30日)
- 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 にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
CLI README の「Extending the CLI」セクションと、その壊れたリンクから始めます。フックとその実行ポイントを洗い出し、続いてプラグインとユーザー向けにその使用方法と例をドキュメント化します。ドキュメント化した例を実行し、それらが引き続き動作することを確認するテストを追加します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- javascript
- 領域
- cli, documentation
- issue の種類
- ドキュメント
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100