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