diff --git a/docs/02-contributing.md b/docs/02-contributing.md index a3b6ffb5..aa002972 100644 --- a/docs/02-contributing.md +++ b/docs/02-contributing.md @@ -97,11 +97,18 @@ If you plan to submit patches, you should follow the following guidelines. ### 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; - do *not* PGP sign your patch; - be *careful* doing cut & paste into your mailer, not to corrupt whitespaces; - if you change, add or remove the user API, the associated documentation should be updated as well; - 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 - *test* it first by sending email to yourself. + the patch is ready for inclusion. If you use git-send-email(1), please *test* + it first by sending email to yourself.