qubes-doc/introduction/contributing.md

---
lang: en
layout: doc
permalink: /doc/contributing/
redirect_from:
- /en/doc/contributing/
- /doc/ContributingHowto/
- /wiki/ContributingHowto/
ref: 125
title: How to contribute
---

Thank you for your interest in contributing to Qubes! Here are some of the many
ways in which you can help:

* Audit the [source code](/doc/source-code/)
* [Report security issues](/security/)
* [Send patches](/doc/source-code/#how-to-send-patches) to fix bugs or
  implement features
* [Contribute packages](/doc/package-contributions)
* [Report bugs](/doc/issue-tracking/)
* [Test new releases and updates](/doc/testing/)
* Submit [HCL reports](/doc/hcl/) for your hardware
* Record [video tours](/video-tours/)
* Create [artwork](https://github.com/QubesOS/qubes-artwork) (plymouth themes,
  installer themes, wallpapers, etc.)
* [Write and edit the documentation](/doc/how-to-edit-the-documentation)
* [Donate](/donate/) to the project
* If you represent an organization, become a [Qubes partner](/partners/)
* Add a [Qubes download mirror](/downloads/mirrors/)
* Answer questions and discuss Qubes on the [mailing lists](/support/) and
  [forum](/support/#forum)
* Engage with us on social media:
  * Follow us on [Twitter](https://twitter.com/QubesOS)
  * Join us on [Reddit](https://www.reddit.com/r/Qubes/)
  * Like us on [Facebook](https://www.facebook.com/QubesOS)
  * Connect with us on [LinkedIn](https://www.linkedin.com/company/qubes-os/)
* And last but not least, tell your friends and colleagues about how Qubes can
  help them secure their digital lives!

Contributing Code
-----------------

If you're interested in contributing code, the best starting point is to have a
look at our [GitHub issues](https://github.com/QubesOS/qubes-issues/issues) to
see which tasks are the most urgent. You can filter issues depending on your
interest and experience. For example, here are some common issue labels:

* [Help wanted](https://github.com/QubesOS/qubes-issues/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22&utf8=%E2%9C%93)
* [UX and usability](https://github.com/QubesOS/qubes-issues/issues?q=is%3Aissue+is%3Aopen+label%3AUX)
* [Windows tools](https://github.com/QubesOS/qubes-issues/issues?q=is%3Aissue+is%3Aopen+label%3A%22C%3A+windows+tools%22)
* [Documentation](https://github.com/QubesOS/qubes-issues/issues?q=is%3Aissue+is%3Aopen+label%3A%22C%3A+doc%22)
* [Privacy](https://github.com/QubesOS/qubes-issues/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20label%3A%22privacy%22%20)
* [Debian](https://github.com/QubesOS/qubes-issues/issues?q=is%3Aissue+is%3Aopen+label%3A%22C%3A+Debian%22)

Before you engage in an activity that will take you a significant amount of
time, like implementing a new feature, it's always good to contact us first,
preferably via the [qubes-devel](/support/#qubes-devel) mailing list. Once
we've worked out the details, we'll be grateful to [receive your
patch](/doc/source-code/#how-to-send-patches).
ContributingHowto changed 2010-04-09 08:11:22 -04:00			`---`
Add lang + ref tags to frontmatter Those are fields used by the language switcher to correlate pages across different languages, even if they have different names/paths/titles. They are generated with the prepare_for_translation.py script. 2021-03-13 13:06:18 -05:00			`lang: en`
wiki -> doc migration 2015-04-10 16:17:45 -04:00			`layout: doc`
Revert "Remove all instances of `permalink:` in YAML frontmatter" This reverts commit c815e4c54c315dfca30c66f6a33e07b1ff90b786. https://github.com/QubesOS/qubes-issues/issues/6701#issuecomment-862822827 2021-06-16 22:56:25 -04:00			`permalink: /doc/contributing/`
Clean up and sort developer documentation 2015-09-25 23:16:18 -04:00			`redirect_from:`
Remove en/ from URLs (QubesOS/qubes-issues#1333) 2015-10-28 18:14:40 -04:00			`- /en/doc/contributing/`
			`- /doc/ContributingHowto/`
			`- /wiki/ContributingHowto/`
Add lang + ref tags to frontmatter Those are fields used by the language switcher to correlate pages across different languages, even if they have different names/paths/titles. They are generated with the prepare_for_translation.py script. 2021-03-13 13:06:18 -05:00			`ref: 125`
Sentence case for titles 2021-07-08 21:06:41 -04:00			`title: How to contribute`
ContributingHowto changed 2010-04-09 08:11:22 -04:00			`---`

Rewrite Contributing page * List all of the main ways in which people can contribute * Provide helpful links for each of those ways * Explain how to contribute code * Provide helpful links to source code, how to send patches, reporting bugs, etc. * Improve wording and formatting in general 2016-11-20 01:45:57 -05:00			`Thank you for your interest in contributing to Qubes! Here are some of the many`
			`ways in which you can help:`
ContributingHowto changed 2010-04-09 08:11:22 -04:00
Refactor links in order to obey the new convention rule 2021-04-10 18:09:05 -04:00			`* Audit the [source code](/doc/source-code/)`
			`* [Report security issues](/security/)`
Wrap text and miscellaneous cleanup 2021-06-18 09:25:06 -04:00			`* [Send patches](/doc/source-code/#how-to-send-patches) to fix bugs or`
			`implement features`
Refactor links in order to obey the new convention rule 2021-04-10 18:09:05 -04:00			`* [Contribute packages](/doc/package-contributions)`
Update links 2021-06-21 03:38:18 -04:00			`* [Report bugs](/doc/issue-tracking/)`
Refactor links in order to obey the new convention rule 2021-04-10 18:09:05 -04:00			`* [Test new releases and updates](/doc/testing/)`
			`* Submit [HCL reports](/doc/hcl/) for your hardware`
			`* Record [video tours](/video-tours/)`
Wrap text and miscellaneous cleanup 2021-06-18 09:25:06 -04:00			`* Create [artwork](https://github.com/QubesOS/qubes-artwork) (plymouth themes,`
			`installer themes, wallpapers, etc.)`
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			`* [Write and edit the documentation](/doc/how-to-edit-the-documentation)`
Refactor links in order to obey the new convention rule 2021-04-10 18:09:05 -04:00			`* [Donate](/donate/) to the project`
			`* If you represent an organization, become a [Qubes partner](/partners/)`
			`* Add a [Qubes download mirror](/downloads/mirrors/)`
Wrap text and miscellaneous cleanup 2021-06-18 09:25:06 -04:00			`* Answer questions and discuss Qubes on the [mailing lists](/support/) and`
			`[forum](/support/#forum)`
Rewrite Contributing page * List all of the main ways in which people can contribute * Provide helpful links for each of those ways * Explain how to contribute code * Provide helpful links to source code, how to send patches, reporting bugs, etc. * Improve wording and formatting in general 2016-11-20 01:45:57 -05:00			`* Engage with us on social media:`
Refactor links in order to obey the new convention rule 2021-04-10 18:09:05 -04:00			`* Follow us on [Twitter](https://twitter.com/QubesOS)`
			`* Join us on [Reddit](https://www.reddit.com/r/Qubes/)`
			`* Like us on [Facebook](https://www.facebook.com/QubesOS)`
			`* Connect with us on [LinkedIn](https://www.linkedin.com/company/qubes-os/)`
Wrap text and miscellaneous cleanup 2021-06-18 09:25:06 -04:00			`* And last but not least, tell your friends and colleagues about how Qubes can`
			`help them secure their digital lives!`
ContributingHowto changed 2010-04-09 08:11:22 -04:00
Rewrite Contributing page * List all of the main ways in which people can contribute * Provide helpful links for each of those ways * Explain how to contribute code * Provide helpful links to source code, how to send patches, reporting bugs, etc. * Improve wording and formatting in general 2016-11-20 01:45:57 -05:00			`Contributing Code`
			`-----------------`
ContributingHowto changed 2010-04-09 08:11:22 -04:00
Rewrite Contributing page * List all of the main ways in which people can contribute * Provide helpful links for each of those ways * Explain how to contribute code * Provide helpful links to source code, how to send patches, reporting bugs, etc. * Improve wording and formatting in general 2016-11-20 01:45:57 -05:00			`If you're interested in contributing code, the best starting point is to have a`
Wrap text and miscellaneous cleanup 2021-06-18 09:25:06 -04:00			`look at our [GitHub issues](https://github.com/QubesOS/qubes-issues/issues) to`
			`see which tasks are the most urgent. You can filter issues depending on your`
			`interest and experience. For example, here are some common issue labels:`
ContributingHowto changed 2010-04-09 08:11:22 -04:00
Contributing document link fix The link to the current github issues with the help wanted tag was pointing to page 3 of the results. 2017-01-14 11:09:07 -05:00			`* [Help wanted](https://github.com/QubesOS/qubes-issues/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22&utf8=%E2%9C%93)`
Rewrite Contributing page * List all of the main ways in which people can contribute * Provide helpful links for each of those ways * Explain how to contribute code * Provide helpful links to source code, how to send patches, reporting bugs, etc. * Improve wording and formatting in general 2016-11-20 01:45:57 -05:00			`* [UX and usability](https://github.com/QubesOS/qubes-issues/issues?q=is%3Aissue+is%3Aopen+label%3AUX)`
			`* [Windows tools](https://github.com/QubesOS/qubes-issues/issues?q=is%3Aissue+is%3Aopen+label%3A%22C%3A+windows+tools%22)`
			`* [Documentation](https://github.com/QubesOS/qubes-issues/issues?q=is%3Aissue+is%3Aopen+label%3A%22C%3A+doc%22)`
			`* [Privacy](https://github.com/QubesOS/qubes-issues/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20label%3A%22privacy%22%20)`
			`* [Debian](https://github.com/QubesOS/qubes-issues/issues?q=is%3Aissue+is%3Aopen+label%3A%22C%3A+Debian%22)`
ContributingHowto changed 2010-04-09 08:11:22 -04:00
Rewrite Contributing page * List all of the main ways in which people can contribute * Provide helpful links for each of those ways * Explain how to contribute code * Provide helpful links to source code, how to send patches, reporting bugs, etc. * Improve wording and formatting in general 2016-11-20 01:45:57 -05:00			`Before you engage in an activity that will take you a significant amount of`
Edit contributing.md Removed one minor instance of e.g. to prevent word/phrase reuse 2017-04-01 11:29:25 -04:00			`time, like implementing a new feature, it's always good to contact us first,`
Wrap text and miscellaneous cleanup 2021-06-18 09:25:06 -04:00			`preferably via the [qubes-devel](/support/#qubes-devel) mailing list. Once`
			`we've worked out the details, we'll be grateful to [receive your`
			`patch](/doc/source-code/#how-to-send-patches).`