Improve in-code documentation
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 20/100
- issue の種類
- ドキュメント
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- python
調査の方向性
まず、Python コードベースを調査して不足している pydocs を確認し、issue で言及されている提案済みの PRs をレビューします。対象範囲には、ほぼすべてのコードにわたるドキュメントと例、およびドキュメント化されていない PRs を防止するためのポリシーが含まれます。完了には、合意されたアプローチと、不足しているドキュメントの広範なカバレッジが必要です。
索引モデルが issue の本文から書いたものです。
説明
Almost all code now lacks proper pydocs across almost all the codebase. We should consider the following PRs are gonna improve the situation.
It should be prohibited to merge PRs that do not have docs. We should eventually cover all the missing places with appropriate documentation and examples.
- 主要言語
- Python
- スター
- 342
- フォーク
- 65
- PR マージ指標
- 30日以内にマージされた PR はありません
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
cloudevents/sdk-python のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
cloudevents/sdk-python#304 ·
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
cloudevents/sdk-python#300 ·
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
cloudevents/sdk-python#291 · コメント 8 件 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 48/100
cloudevents/sdk-python#247 · コメント 2 件 ·
-
question
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
cloudevents/sdk-python#246 · コメント 5 件 ·
cloudevents/sdk-python の issue をすべて見る
似ている issue
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
canonical/paas-charm#368 · コメント 1 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
tech debt
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
StevenBlack/hosts#3256 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
qualcomm/qai-appbuilder#275 ·