beautiful: merge awful.beautiful, stop registering system
[awesome.git] / PATCHES
blobcc050de6981233347e7e3b4053bdfdba9a01dfc0
1 If you plan to submit patches, here's a checklist:
3  Commits:
5 - make commits of logical units;
6 - check for unnecessary whitespace with "git diff --check" before commiting;
7 - do not check in commented out code or unneeded files;
8 - provide a meaningful commit message;
9 - the first line of the commit message should be a short;
10   description and should skip the full stop;
11 - if you want your work included, add a
12   "Signed-off-by: Your Name <you@example.com>" line to the
13   commit message (or just use the option "-s" when commiting);
14 - make sure that you have tests for the bug you are fixing.
16  Patch:
18 - use "git format-patch -M" to create the patch;
19 - do not PGP sign your patch;
20 - be careful doing cut & paste into your mailer, not to corrupt whitespaces;
21 - if you change, add or remove the user API, the associated documentation
22   should be updated as well;
23 - send the patch to the list (awesome-devel@naquadah.org) if (and only if)
24   the patch is ready for inclusion. If you use git-send-email(1), please
25   test it first by sending email to yourself.