[mkdocs] Improve descriptions
オープン
まだ誰も着手していません。
documentation
P2
- 主要言語
- Python
- スター
- 18.8k
- フォーク
- 2.8k
- 平均マージ
- 16時間 26分
- マージ済み PR（30日）
- 21
説明
Looking at https://github.com/daexs/plotly.py/pull/80/files, some of the descriptions are very short and not informative.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、参照されている pull request に示されたファイルと説明の変更を確認します。短すぎる、または情報量が不十分な説明を特定し、対象となるドキュメントがより明確になるよう更新します。関連する説明が、必要以上に簡潔にならず有用なコンテキストを提供できれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 35/100