Add "Writing Documentation" section to CONTRIBUTING.md
Open
Nobody has claimed this yet.
area/documentation
- Dominant language
- TypeScript
- Stars
- 15.2k
- Forks
- 1.5k
- Avg merge
- 3d 18h
- Merged PRs (30d)
- 6
Description
Describe the solution you'd like
Contribution guidelines for writing documentation. (P.S. And maybe add a 'docs' folder?)
Additional context
After submitting https://github.com/VSCodeVim/Vim/pull/5227 I thought of this
Relevant issues:
- https://github.com/VSCodeVim/Vim/issues/5079 (perhaps this new issue should go in 5079)
- https://github.com/VSCodeVim/Vim/issues/3588
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 CONTRIBUTING.md and review the documentation-related context in issues #5079 and #3588, along with pull request #5227. Done means CONTRIBUTING.md contains a writing-documentation contribution section; whether a separate docs folder is needed remains unspecified.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100