Code-dot-mil / Code-dot-mil/code.mil
Add documentation on how to do good OSS documentation
Open
[effort] small
[issue-type] content
[skill-level] beginner
code.gov
help wanted
- Dominant language
- JavaScript
- Stars
- 1.3k
- Forks
- 144
- PR merge metrics
- No merged PRs in 30d
Description
## Feature
We would like to have better documentation on how to create good open source software documentation as guidance for Department organizations wishing to open source things. This should include things like relevant sections of a "contributing" doc (not just a link to an example), how to write and review PRs, good commit messages, how to write a good GH issue, etc.
## Page(s) Affected
This could go on https://www.code.mil/how-to-open-source.html ("How to Open Source"), but it could live on it's own page, linked a couple of places.
Contributor guide
Assessment
This issue has not been assessed yet.