Fill in Stub Documentation
Open
Nobody has claimed this yet.
- Dominant language
- Dockerfile
- Stars
- 1
- Forks
- 2
- Avg merge
- 22m
- Merged PRs (30d)
- 4
Description
#55 exposed a lot of places where our developer documentation could be expanded. As part of #55 we added stubs. This issue is meant for high-level tracking of the stubs we added (and the progress of filling in the stubs).
- integration testing
- performance testing
- unit testing
- writing API documentation
- writing developer documentation
- code of conduct (and re-enable link in
CONTRIUBTING.md)
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
Review the stubs introduced by #55 and use the checklist as the scope for the documentation work. Start by locating the integration, performance, unit, API, developer documentation, and code-of-conduct stubs; completion means each checklist item is addressed and the link in CONTRIUBTING.md is re-enabled.
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
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100