MagicStack / MagicStack/asyncpg
Document internals
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 8.1k
- Forks
- 469
- Ø Merge
- 18 Min.
- Gemergte PRs (30 T.)
- 4
Beschreibung
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
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit der Durchsicht der Interna unter asyncpg/protocol und des im Issue beschriebenen PostgreSQL-Protokollkontexts. Lege den Umfang der Dokumentation mit den Maintainer:innen fest und dokumentiere anschließend die relevanten Interna, damit Contributors sie verstehen und asyncpg als Protokollreferenz verwenden können.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- postgresql, python
- Bereich
- databases, documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 25/100