MagicStack / MagicStack/asyncpg
Document internals
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 8.1k
- Forks
- 468
- PR merge metrics
- No merged PRs in 30d
Description
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
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the internals under asyncpg/protocol and the PostgreSQL protocol context described in the issue. Define the documentation scope with maintainers, then document the relevant internals so contributors can understand them and use asyncpg as a protocol reference.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- postgresql, python
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100