CONTRIBUTING

   1 Contributing to this project
   2 ----------------------------
   3
   4 This project accepts contributions. In order to contribute, you should
   5 pay attention to a few things:
   6
   7     1 - your code must follow the coding style rules
   8     2 - the format of the submission must be email patches
   9     3 - your work must be signed
  10
  11
  12 Coding Style:
  13 -------------
  14
  15 The coding style follows the Linux kernel coding style.
  16
  17 The coding style is defined in the 'CodingStyle' file, available in
  18 the directory 'Documentation' of the Linux kernel source tree.
  19
  20 It can be accessed online too:
  21
  22 http://lxr.linux.no/linux+v2.6.27/Documentation/CodingStyle
  23
  24 Submitting Modifications:
  25 -------------------------
  26
  27 The contributions should be email patches. The guidelines are the same
  28 as the patch submission for the Linux kernel except for the DCO which
  29 is defined below. The guidelines are defined in the
  30 'SubmittingPatches' file, available in the directory 'Documentation'
  31 of the Linux kernel source tree.
  32
  33 It can be accessed online too:
  34
  35 http://lxr.linux.no/linux+v2.6.27/Documentation/SubmittingPatches
  36
  37 You can submit your patches to the lxc-devel@lists.linuxcontainers.org mailing
  38 list. Use http://lists.linuxcontainers.org/listinfo/lxc-devel to subscribe
  39 to the list.
  40
  41
  42 Licensing for new files:
  43 ------------------------
  44
  45 LXC is made of files shipped under a few different licenses.
  46
  47 Anything that ends up being part of the LXC library needs to be released
  48 under LGPLv2.1+ or a license compatible with it (though the latter will
  49 only be accepted for cases where the code originated elsewhere and was
  50 imported into LXC).
  51
  52 Language bindings for the libraries need to be released under LGPLv2.1+.
  53
  54 Anything else (non-libaries) needs to be Free Software and needs to be
  55 allowed to link with LGPLv2.1+ code (if needed). LXC upstream prefers
  56 LGPLv2.1+ or GPLv2 for those.
  57
  58
  59 When introducing a new file into the project, please make sure it has a
  60 copyright header making clear under which license it's being released
  61 and if it doesn't match the criteria described above, please explain
  62 your decision on the lxc-devel mailing-list when submitting your patch.
  63
  64
  65 Developer Certificate of Origin:
  66 --------------------------------
  67
  68 To improve tracking of contributions to this project we will use a
  69 process modeled on the modified DCO 1.1 and use a "sign-off" procedure
  70 on patches that are being emailed around or contributed in any other
  71 way.
  72
  73 The sign-off is a simple line at the end of the explanation for the
  74 patch, which certifies that you wrote it or otherwise have the right
  75 to pass it on as an open-source patch.  The rules are pretty simple:
  76 if you can certify the below:
  77
  78 By making a contribution to this project, I certify that:
  79
  80 (a) The contribution was created in whole or in part by me and I have
  81     the right to submit it under the open source license indicated in
  82     the file; or
  83
  84 (b) The contribution is based upon previous work that, to the best of
  85     my knowledge, is covered under an appropriate open source License
  86     and I have the right under that license to submit that work with
  87     modifications, whether created in whole or in part by me, under
  88     the same open source license (unless I am permitted to submit
  89     under a different license), as indicated in the file; or
  90
  91 (c) The contribution was provided directly to me by some other person
  92     who certified (a), (b) or (c) and I have not modified it.
  93
  94 (d) The contribution is made free of any other party's intellectual
  95     property claims or rights.
  96
  97 (e) I understand and agree that this project and the contribution are
  98     public and that a record of the contribution (including all
  99     personal information I submit with it, including my sign-off) is
 100     maintained indefinitely and may be redistributed consistent with
 101     this project or the open source license(s) involved.
 102
 103
 104 then you just add a line saying
 105
 106     Signed-off-by: Random J Developer <random@developer.org>
 107
 108 using your real name (sorry, no pseudonyms or anonymous contributions.)