mirror of
https://github.com/QubesOS/qubes-doc.git
synced 2025-02-13 13:31:24 -05:00
c29cf40910
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.
61 lines
2.9 KiB
Markdown
61 lines
2.9 KiB
Markdown
---
|
|
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).
|