mirror of
https://github.com/QubesOS/qubes-doc.git
synced 2024-10-01 01:25:40 -04:00
Update contribution guide
This commit is contained in:
parent
6126f7c0f5
commit
c5069f2000
@ -21,6 +21,8 @@ Perhaps the best starting point is to have a look at the [issues](https://github
|
||||
|
||||
Before you engage in some longer activity, e.g. implementing a new feature, it's always good to contact us first (preferably via the [qubes-devel](/doc/QubesLists/) list), to avoid a situation when two or more independent people would work on the same feature at the same time, doubling each others work. When you contact us and devote to a particular task, we will create a ticket for this task with info who is working on this feature and what is the expected date of some early code to be posted.
|
||||
|
||||
When you are ready to start some work, read how to [access Qubes sources and send patches](/doc/SourceCode/).
|
||||
|
||||
You can also contribute in other areas than coding and testing, e.g. by providing mirrors for Qubes rpm repositories, providing feedback about what features you would like to have in Qubes, or perhaps even preparing some cool You Tube videos that would demonstrate some Qubes' features. You are always encouraged to discuss your ideas on qubes-devel.
|
||||
|
||||
You should be aware, however, that we will not blindly accept all the contributions! We will accept only the quality ones. Open source doesn't mean lack of quality control! If we reject your patch, please do not get discouraged, try fixing it so that it adheres to the required standards. We will only reject contributions in the good faith, to make Qubes a better OS.
|
||||
|
18
DocStyle.md
18
DocStyle.md
@ -22,3 +22,21 @@ Guidelines for Documentation Contributors
|
||||
where appropriate.
|
||||
* Use `[reference-style][ref]` links.
|
||||
`[ref]: http://daringfireball.net/projects/markdown/syntax#link`
|
||||
|
||||
|
||||
Sending documentation updates
|
||||
-----------------------------
|
||||
|
||||
Main documentation repository is [qubes-doc] on [QubesOS] github account. If
|
||||
you want to add something there, clone that repository commit the changes and
|
||||
send us patches using either [github pull requests][github-forking] or [plain
|
||||
email sent to qubes-devel mailing list][patch].
|
||||
|
||||
If you have a github account (its free!), you can simply browse [qubes-doc]
|
||||
repository and edit the files there! Github interface will automatically guide
|
||||
you through [fork & pull request creation process][github-forking].
|
||||
|
||||
[qubes-doc]: https://github.com/QubesOS/qubes-doc
|
||||
[QubesOS]: https://github.com/QubesOS/
|
||||
[github-forking]: https://guides.github.com/activities/forking/
|
||||
[patch]: /doc/SourceCode/#sending-a-patch
|
||||
|
@ -31,18 +31,15 @@ e.g.:
|
||||
git clone git://github.com/QubesOS/qubes-core-admin.git core-admin
|
||||
{% endhighlight %}
|
||||
|
||||
If you want to contribute to the project, there are two preferred ways:
|
||||
|
||||
1. Use github [fork & pull requests](https://guides.github.com/activities/forking/)
|
||||
2. [sending a patch](/doc/DevelFaq/#q-how-do-i-submit-a-patch) via the project's mailing list (`git format-patch`).
|
||||
|
||||
## Sending a patch
|
||||
1. Make all the changes in your working directory, i.e. edit files, move them around (you can use 'git mv' for this), etc.
|
||||
|
||||
2. Add the changes and commit them (git add, git commit). Never mix different changes into one commit! Write a good description of the commit. The first line should contain a short summary, and then, if you feel like more explanations are needed, enter an empty new line, and then start the long, detailed description (optional).
|
||||
If you want to contribute to the project, there are two ways:
|
||||
|
||||
3. Test your changes NOW: check if RPMs build fine, etc.
|
||||
* **Preferred**: Use github [fork & pull requests](https://guides.github.com/activities/forking/)
|
||||
* Sending a patch via the project's mailing list (`git format-patch`).
|
||||
|
||||
4. Create the patch using 'git format-patch'. This has an advantage over 'git diff', because the former will also include your commit message, your name and email, so that \*your\* name will be used as a commit's author.
|
||||
|
||||
5. Send your patch to qubes-devel. Start the message subject with the '[PATCH]' string.
|
||||
1. Make all the changes in your working directory, i.e. edit files, move them around (you can use 'git mv' for this), etc.
|
||||
2. Add the changes and commit them (git add, git commit). Never mix different changes into one commit! Write a good description of the commit. The first line should contain a short summary, and then, if you feel like more explanations are needed, enter an empty new line, and then start the long, detailed description (optional).
|
||||
3. Test your changes NOW: check if RPMs build fine, etc.
|
||||
4. Create the patch using 'git format-patch'. This has an advantage over 'git diff', because the former will also include your commit message, your name and email, so that \*your\* name will be used as a commit's author.
|
||||
5. Send your patch to qubes-devel. Start the message subject with the '[PATCH]' string.
|
||||
|
Loading…
Reference in New Issue
Block a user