We’d love your help.
- Have you noticed something that could be improved?
- Want to share your tech writing expertise?
- Do you have material you’d like to integrate into our baseline?
- Do you know of research which should be referenced?
- Something else?
Please do reach out to us with your ideas.
- Slack: https://thegooddocs.slack.com/
- Email list: https://groups.io/g/thegooddocsproject/
By contributing to this project we expect you to agree to the Developer Certificate of Origin (DCO). This document was created by the Linux Kernel community and is a simple statement that you, as a contributor, have the legal right to make the contribution, and agree to do so under the open licenses we use.
You can improve our documentation by submitting a pull request to our Github templates repo. Here is how.
For all but minor typos, it is s a good idea to discuss your proposed changes with us before submitting a pull request.
- Create an issue in the github tracker.
- Be as specific as you can in the scope of work within the issue. Be sure to include the "why" for considering the work.
- Share the link to the bug on the #general channel in our Slack instance to get a review of your idea.
- Once folks agree on your proposed changes you can begin work.
We track outstanding work in our github tracker. To keep our issue tracker manageable, we prefer you discuss suggestions or issues in one of our forums, typically our email list, before adding an issue to the tracker.
We use the Google Style Guide and American spelling, as per the Merriam-Webster Online dictionary. If you’re used to working with such reference books, that’s great; if not, please contribute anyway, a tech writer will likely update your contribution later.