README Formatting suggestion
オープン
まだ誰も着手していません。
- 主要言語
- JavaScript
- スター
- 11.8k
- フォーク
- 7.9k
- 平均マージ
- 1日 11時間
- マージ済み PR（30日）
- 11
説明
The README is comprehensive and helpful, and could be even better served if at the top of the README there was a row of all the major header (perhaps even linked to jump the the part of the page it references), and a description of aforementioned headers so that users could more easily navigate it, especially for newcomers.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まずリポジトリの README を開き、既存の主要な見出しと構成を確認します。先頭付近に、それらの見出しと簡潔な説明を含むリンク付きの行を追加し、その後、各リンクが意図したセクションに移動することと、README が初心者にも読みやすいままであることを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 1/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100