nushell / nushell/nushell.github.io
The contributing notes for the nu website is missing a style guide
オープン
まだ誰も着手していません。
- 主要言語
- TypeScript
- スター
- 258
- フォーク
- 561
- 平均マージ
- 3時間 20分
- マージ済み PR(30日)
- 15
説明
It would also be nice to add some style guides for contributing to the book. Currently the style of e.g. code examples is a bit inconsistent. For example:
- Code examples should use the nu formatting as in
```nu, currently this is not very consistent as I seenone,bash,sh,nuandnushellused. I think it would be nice to have these consisten. - Another that might be nice is to use a consistent style for output formating of tables. E.g. "examples of table output should use rounded corners" (don't actually mean it needs to be rounded, just that we would use a consistent styling"
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、ウェブサイトのコントリビューション向けの注記と、それらが扱っている書籍の内容を見つけます。Nu のコードフェンスのラベルに一貫性を持たせ、表の出力には単一のスタイルを定めて文書化します。その後、周囲の例を確認し、ガイダンスが明確で適用可能であることを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- shell
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 50/100