Git-Mirrors/qubes-doc
1
0
Fork 0
mirror of https://github.com/QubesOS/qubes-doc.git synced 2024-12-27 00:09:26 -05:00
Code Issues Packages Projects Releases Wiki Activity

Create Package Contributions page

Browse Source 
QubesOS/qubes-issues#2876
This commit is contained in:
Andrew David Wong 2017-06-28 20:48:24 -05:00
parent 3923a4c3f6
commit ec56b8c2b5
No known key found for this signature in database
GPG Key ID: 8CE137352A019A17
1 changed files with 48 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
basics_dev/package-contributions.md Normal file
View File

@ -0,0 +1,48 @@
---
layout: doc
title: Package Contributions
permalink: /doc/package-contributions/
---
Package Contributions
=====================
**Notice:** *This is an unofficial draft. Once this information is official, this notice will be removed.*
Procedure
---------
If you would like to contribute a package to Qubes, please follow this procedure:
1. Ensure that your package satisfies the [Inclusion Criteria].
2. If your code isn't already on GitHub, create a GitHub repo that contains your code.
3. If you haven't already, [sign your code][sig].
4. Create an issue in [qubes-issues] with the title `[Contribution] your-package-name`.
Include a link to your repo, a brief description of your package, and a brief explanation of why you think it should be included in Qubes.
5. You may be asked followup questions.
If we decide to accept your contribution, you will be invited to join the [QubesOS-contrib] organization on GitHub, and [QubesOS-contrib] will fork your repo.
If we decide not to accept your contribution, we will state the reason and close the issue.
Inclusion Criteria
------------------
In order to be accepted, packages must:
* In no way weaken the security of Qubes OS.
* Be published under an open-source license.
* Follow our [coding guidelines].
* Be thoroughly tested.
* Have a clearly defined use case for Qubes users.
* Not be unduly burdensome to review.
(Please note that we always reserve the right add criteria to this list.)
Updates
-------
If you would like to update or patch an existing contributed package (i.e., code in a fork owned by [QubesOS-contrib]), whether it is your contribution or someone else's, please submit a [signed][sig], fast-forwarded pull request to that repo with your changes.
Please note that your pull request **must** be both [signed][sig] and fast-forwarded, or else it will be closed without further review.
[Inclusion Criteria]: #inclusion-criteria
[sig]: /doc/code-signing/
[qubes-issues]: https://github.com/QubesOS/qubes-issues/issues/
[QubesOS-contrib]: https://github.com/QubesOS-contrib
[coding guidelines]: /doc/coding-style/