cloudevents / cloudevents/sdk-python
Improve in-code documentation
オープン
まだ誰も着手していません。
enhancement
- 主要言語
- Python
- スター
- 342
- フォーク
- 65
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
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.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、Python コードベースを調査して不足している pydocs を確認し、issue で言及されている提案済みの PRs をレビューします。対象範囲には、ほぼすべてのコードにわたるドキュメントと例、およびドキュメント化されていない PRs を防止するためのポリシーが含まれます。完了には、合意されたアプローチと、不足しているドキュメントの広範なカバレッジが必要です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 20/100