qubes-doc/CONTRIBUTING.md

# Contributing to `qubes-doc`

Thank you for your interest in contributing to `qubes-doc`, the Qubes OS
Project's dedicated documentation repository! Please see [how to edit the
documentation](https://www.qubes-os.org/doc/how-to-edit-the-documentation/) for
detailed contribution instructions.

In addition, please take a moment to read our [documentation style
guide](https://www.qubes-os.org/doc/documentation-style-guide/) before
contributing. These guidelines are important to maintaining high standards of
quality, and following them will increase the likelihood that your contribution
will be accepted.
Update heading syntax; wrap text 2021-06-19 23:24:57 -04:00			# Contributing to `qubes-doc`
Create CONTRIBUTING file https://help.github.com/articles/setting-guidelines-for-repository-contributors/ 2016-04-06 04:32:30 -04:00
			Thank you for your interest in contributing to `qubes-doc`, the Qubes OS
Reorganize doc guidelines into multiple pages; update style guide The existing doc guidelines page attempts to combine too many different topics at once and includes information that does not pertain directly to the documentation. This reorganization is intended to make each type of information easier to find. For example, some have found it difficult to find the documentation style guidelines (see, e.g., QubesOS/qubes-issues#6701#issuecomment-875875610). This reorganization allows us to assign more specific titles to each page. General changes: - Create new page for contribution instructions - Create new page for website style guide - Create new page for continuous integration - Rename existing "style guide" to "visual style guide" in order to avoid ambiguity with new doc and website style guides - Retain existing page solely for doc style guide - Update page names and permalinks - Update existing links - Improve language Doc style guide changes: - Add section on using sentence case in headings (see QubesOS/qubes-issues#6756 and #1173) - Improve section organization - Clarify language In order to better preserve the Git history of each file, file renames will be handled in a separate commit. 2021-07-08 10:41:19 -04:00			`Project's dedicated documentation repository! Please see [how to edit the`
			`documentation](https://www.qubes-os.org/doc/how-to-edit-the-documentation/) for`
			`detailed contribution instructions.`

			`In addition, please take a moment to read our [documentation style`
			`guide](https://www.qubes-os.org/doc/documentation-style-guide/) before`
			`contributing. These guidelines are important to maintaining high standards of`
			`quality, and following them will increase the likelihood that your contribution`
			`will be accepted.`