nushell / nushell/nushell.github.io
Use cookbook to explain some nu_scripts
オープン
まだ誰も着手していません。
documentation
enhancement
- 主要言語
- TypeScript
- スター
- 258
- フォーク
- 561
- 平均マージ
- 3時間 20分
- マージ済み PR(30日)
- 15
説明
Currently, the cookbook is rather underwhelming. The idea of the cookbook is to show practical recipes and how-to guides with explanations. One idea how to add more content is to take some nice script from nu_scripts and go through it in detail in a cookbook page. This has two benefits:
- Enhanced in-depth documentation for scripts in nu_scripts
- More cookbook content
Of course, we can think of other scripts to add to nu_scripts that would be interesting to cover in the cookbook.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、既存の cookbook ページとリンクされている nu_scripts リポジトリを確認し、現在のカバレッジを把握します。適切なスクリプトを特定し、それを中心とした詳細な cookbook ガイドの概要を作成します。スクリプトを説明し、詳しい使い方を提供する実践的なページを追加するとともに、対象スクリプトのドキュメントを改善できれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 領域
- content, documentation
- issue の種類
- ドキュメント
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 30/100