Contribute

There are multiple ways to help improve our documentation:

All contributions must follow our code of conduct.

Contribute via GitHub

Our documentation is hosted in GitHub and we follow the standard GitHub flow. Here are the basic steps for contributing:

  1. Clone the documentation repository.
  2. Create your own fork of the repository.
  3. Create a branch for your contribution.
  4. Add your commits.
  5. Open a pull request.
  6. Discuss, review, and update your contributions.
  7. Once the maintainer approves, your contribution is merged and published as part of the documentation.

Contribution guidelines

The Clear Linux OS documentation is written using reStructuredText. Use our guidelines and best practices to write consistent, readable documentation.

References

We use the following references for grammar, style, and formatting: