readthedocs / readthedocs/sphinx-autoapi
Write a contribution guide
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 494
- Forks
- 147
- Avg merge
- 9m
- Merged PRs (30d)
- 1
Description
The new landing page of the documentation introduces the maintainer guide as though that section will guide someone through making a contribution. No such content exists, so write a contribution for just that purpose.
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 at the documentation's new landing page and the maintainer guide section it introduces; inspect nearby documentation for structure and contribution conventions. Done when that section contains contribution guidance for someone making a contribution and no longer presents missing content.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100