awesomewm-mirrors
/
awesome
mirror of https://github.com/awesomeWM/awesome.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs/02-contributing.md: fix/improve Patches section

This commit is contained in:
Daniel Hahler 2015-02-26 14:52:45 +01:00
parent 74f2596ae7
commit 12f8be1824
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/02-contributing.md
View File

@ -97,11 +97,18 @@ If you plan to submit patches, you should follow the following guidelines.
### Patches ### Patches
Submitting patches via pull requests on the Github project is the preferred
method.
#### Pull request
- create a [pull request](https://github.com/awesomeWM/awesome/pulls)
#### git-send-email
- use `git format-patch -M` to create the patch; - use `git format-patch -M` to create the patch;
- do *not* PGP sign your patch; - do *not* PGP sign your patch;
- be *careful* doing cut & paste into your mailer, not to corrupt whitespaces; - be *careful* doing cut & paste into your mailer, not to corrupt whitespaces;
- if you change, add or remove the user API, the associated documentation - if you change, add or remove the user API, the associated documentation
should be updated as well; should be updated as well;
- send the patch to the list (`awesome-devel@naquadah.org`) if (and only if) - send the patch to the list (`awesome-devel@naquadah.org`) if (and only if)
the patch is ready for inclusion. If you use git-send-email(1), please the patch is ready for inclusion. If you use git-send-email(1), please *test*
*test* it first by sending email to yourself. it first by sending email to yourself.