Contributor documentation overhaul
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 36
- Forks
- 39
- Avg merge
- 2d 5h
- Merged PRs (30d)
- 3
Description
More structure so we can encourage appropriate docs updates as part of PRs for features or bug fixes. More contents to better guide contributors.
- Audit? see OpenDocs audit methodology
- Structure that splits docs by role between developers and content authors
- Structure that scales better with more docs
- Docs for more QA scenarios
- Design goals docs (browser support, languages support, maintenance goals, etc)
- More docs for PR review
- Architecture of the project
- More?
Contributor guide
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
The issue names no repository files or tests; start with the linked OpenDocs audit methodology and review the current contributor documentation. Define a documentation structure that covers the listed contributor roles, QA scenarios, design goals, PR review, and architecture, then confirm each planned area has an appropriate location and guidance.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100