Add CONTRIBUTING.md docs on documentation
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Markdown
- Stars
- 46
- Forks
- 40
- Avg merge
- 4h 3m
- Merged PRs (30d)
- 6
Description
Explain how our helm-docs architecture works!
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
Start with the repository's CONTRIBUTING.md and inspect the existing helm-docs documentation and configuration. Document how the helm-docs architecture works, including the parts a contributor needs to understand. Done means CONTRIBUTING.md gives contributors a usable overview of that architecture.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- helm
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100