pypa / pypa/packaging.python.org
Be explicit that the Diataxis process is being used
Open
Nobody has claimed this yet.
type: task
- Dominant language
- Python
- Stars
- 1.7k
- Forks
- 1.7k
- Avg merge
- 3d 12h
- Merged PRs (30d)
- 4
Description
Provide information and link to Diataxis https://diataxis.fr/ on the Contributing page and in the README.
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 with the Contributing page and README, then review the Diataxis site linked in the issue. Add a brief explanation that the project uses the Diataxis process and link to https://diataxis.fr/ in both locations; done means both pages contain the information and working link.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100