PATCHES

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