Documentation/Contributing

   1 There's not much to helping develop Guilt. Most of the following has been
   2 adapted, or blatantly stolen from the Linux kernel's
   3 Documentation/SubmittingPatches file. :)
   4
   5 1) Hack on the code a bit
   6
   7 Please follow this style guide:
   8
   9  - Use tabs for indentation.
  10
  11  - Put "then" on the same line as "if".
  12
  13  - Follow the style of the existing code, except if it breaks the
  14    above guidlines.
  15
  16  - If you change the code to conform to the style guide, please do so
  17    in a separate commit that does not change anything else.
  18
  19 Please check that you change does not break "make test".  Please add
  20 new testcases for any new functionality, and if you fix a bug.
  21
  22 2) Make a patch:
  23
  24 Use "diff -up" or "diff -uprN" to create patches. Or simply use git to
  25 create patches against the latest version. And of course, you can use guilt
  26 to develop guilt. ;)
  27
  28 3) Describe the changes:
  29
  30 If you generated a patch using diff, make sure you include a description of
  31 your changes at the beginning of the patch. If you used git, make sure the
  32 git commit message contains a good description of the changes.
  33
  34 Prefix the email's subject with "[GUILT]" so it will not be confused with
  35 other git changes. For example:
  36   Subject: [GUILT] fix important bug
  37
  38 4) Send the patches to: Jeff Sipek <jeffpc@josefsipek.net>, CC'ing
  39 the Git mailing list (git@vger.kernel.org).
  40
  41 5) Sign your work:
  42
  43 To improve tracking of who did what, especially with patches that can
  44 percolate to their final resting place in the kernel through several
  45 layers of maintainers, we've introduced a "sign-off" procedure on
  46 patches that are being emailed around.
  47
  48 The sign-off is a simple line at the end of the explanation for the
  49 patch, which certifies that you wrote it or otherwise have the right to
  50 pass it on as a open-source patch.  The rules are pretty simple: if you
  51 can certify the below:
  52
  53         Developer's Certificate of Origin 1.1
  54
  55         By making a contribution to this project, I certify that:
  56
  57         (a) The contribution was created in whole or in part by me and I
  58             have the right to submit it under the open source license
  59             indicated in the file; or
  60
  61         (b) The contribution is based upon previous work that, to the best
  62             of my knowledge, is covered under an appropriate open source
  63             license and I have the right under that license to submit that
  64             work with modifications, whether created in whole or in part
  65             by me, under the same open source license (unless I am
  66             permitted to submit under a different license), as indicated
  67             in the file; or
  68
  69         (c) The contribution was provided directly to me by some other
  70             person who certified (a), (b) or (c) and I have not modified
  71             it.
  72
  73         (d) I understand and agree that this project and the contribution
  74             are public and that a record of the contribution (including all
  75             personal information I submit with it, including my sign-off) is
  76             maintained indefinitely and may be redistributed consistent with
  77             this project or the open source license(s) involved.
  78
  79 then you just add a line saying
  80
  81         Signed-off-by: Random J Developer <random@developer.example.org>
  82
  83 using your real name (sorry, no pseudonyms or anonymous contributions.)
  84
  85 Some people also put extra tags at the end.  They'll just be ignored for
  86 now, but you can do this to mark internal company procedures or just
  87 point out some special detail about the sign-off.
  88