Join the The Good Docs Project community
The Good Docs Project is an open source project that anyone in the community can use, improve, and enjoy. We'd love you to join us! Here's a few ways to find out what's happening and get involved.
Learn and Connect
Using or want to use The Good Docs Project? Find out more here:
- General mailing list: Discussion and help from your fellow users
- Announcements mailing list: Announcements about releases and key events
- Twitter: Follow us on Twitter to get the latest news!
- Season of Docs 2020: Information for 2020 Season of Docs participants
Develop and Contribute
If you want to get more involved by contributing to The Good Docs Project, join us here:
You can find out how to contribute to these docs in our Contribution Guidelines.
How to Contribute
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.
Consider contributing financially. We have an Open Collective account where you can make a one-off donation or provide ongoing support as a sponsor.
About contributing
Licenses
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.
Contributing
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.
Issue tracker
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.
Style Guide
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.