nushell / nushell/nushell.github.io
Move Philosophy into Book
まだ誰も着手していません。
- 主要言語
- TypeScript
- スター
- 258
- フォーク
- 561
- 平均マージ
- 3時間 20分
- マージ済み PR(30日)
- 15
説明
The book does a great job on the How. It explains well how Nushell works. But it lacks a bit on the Why. The Introduction hints on it but it seems to get lost on the surface, e.g. "modern style of development", "modern feel", "UX polish". New users tend to want to know the Why first before the How.
The Philosophy section of the Contributor Book does a great job on the Why. But it's usually read only long after the How and only by people interested in the underlying details.
I'd like to propose moving the Why before the How. This means moving the Philosophy section into the main book before any concrete "Usage" sections. It would probably make sense to put it just after the Installation section.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
Contributor Book の Philosophy セクションを、メインブックの構成、特に Installation セクションと Usage セクションと比較する。メインブック内で Philosophy を Installation の後、具体的な Usage セクションの前に移動する。Why が How より前に提示され、Contributor Book での以前の配置が処理されれば完了。
索引モデルが issue の本文から書いたものです。
評価
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 停滞
- 明瞭さ
- 明確に書かれている
- 初心者へのやさしさ
- 45/100