The Good Docs Project

Templates to make good docs.

Home | About | Licences | Contribute |

How to Contribute

We’d love your help.

Please do reach out to us with your ideas.

Contact us

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.