MagicStack / MagicStack/asyncpg
Document internals
オープン
まだ誰も着手していません。
enhancement
- 主要言語
- Python
- スター
- 8.1k
- フォーク
- 468
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
As mentioned in HN, documenting internals (the https://github.com/MagicStack/asyncpg/tree/master/asyncpg/protocol would make it easier to contribute or even use asyncpg as a reference implementation of the protocol
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず asyncpg/protocol 配下の内部実装と、issue で説明されている PostgreSQL プロトコルのコンテキストを確認します。maintainer とドキュメントの対象範囲を定義し、その後、contributor が関連する内部実装を理解して asyncpg をプロトコルリファレンスとして利用できるように、該当する内部実装をドキュメント化します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- postgresql, python
- 領域
- databases, documentation
- issue の種類
- ドキュメント
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 25/100