Contribute

There are multiple ways to help improve our documentation:

• Contribute via GitHub: Submit pull requests in the GitHub* documentation repository.

• Log an issue: Enter an issue in the documentation repository for minor issues such as typos.

• Make a suggestion: Send your documentation suggestion to the mailing list.

• Test documentation: Step through our guides and tutorials to verify the instructions. Log an issue or submit a pull request with your findings.

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. If you’re writing a tutorial, review our skill levels to better target a user group.

• Writing guide
• Structure and formatting guide

References

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

• Microsoft Writing Style Guide

• Merriam-Webster Dictionary

• The Chicago Manual of Style (15th edition), The University of Chicago Press

• Microsoft Press Computer Dictionary, Microsoft Press

• Read Me First!, Oracle Technical Publications