linkedin / linkedin/python-avro-json-serializer
Better doc
オープン
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 135
- フォーク
- 43
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
Hi,
I'm a user of your library, it's great.
I had a couple of suggestion to improve the doc:
- add how to install w/ pip
- add imports statement to the examples
- add deserialize example
I can actually do it if you want.
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まずプロジェクトの現在のドキュメントと例を見つけ、次にインストールとシリアライズが現在どのように説明されているかを確認します。ドキュメントを更新して、pip によるインストール、例での imports、deserialize の例を含めます。3つの要求すべてがカバーされ、例が引き続き理解しやすければ完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 半日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 45/100