]> git.proxmox.com Git - mirror_lxc.git/blobdiff - CONTRIBUTING
conf: don't send ttys when none are configured
[mirror_lxc.git] / CONTRIBUTING
index 458c3e68b7040b52f9e80b4a96037f5fb02af0eb..d3c343c11ec739d4c11db9333e0cfec451114bab 100644 (file)
@@ -1,13 +1,12 @@
-
-       Contributing to this project
-        ----------------------------
-
+Contributing to this project
+----------------------------
 
 This project accepts contributions. In order to contribute, you should
 pay attention to a few things:
 
     1 - your code must follow the coding style rules
-    2 - the format of the submission must email patches
+    2 - the format of the submission must be email patches or github
+    pull requests
     3 - your work must be signed
 
 
@@ -19,22 +18,50 @@ The coding style follows the Linux kernel coding style.
 The coding style is defined in the 'CodingStyle' file, available in
 the directory 'Documentation' of the Linux kernel source tree.
 
-It can be accessible online too:
+It can be accessed online too:
 
 http://lxr.linux.no/linux+v2.6.27/Documentation/CodingStyle
 
 Submitting Modifications:
 -------------------------
 
-The contributions should be email patches. The guidelines are the same
-as the patch submission for the Linux kernel except for the DCO which
-is defined below. The guidelines are defined in the
+The contributions should be email patches or github pull requests.
+The guidelines are the same as the patch submission for the Linux kernel
+except for the DCO which is defined below. The guidelines are defined in the
 'SubmittingPatches' file, available in the directory 'Documentation'
 of the Linux kernel source tree.
 
-It can be accessible online too:
+It can be accessed online too:
+
+https://www.kernel.org/doc/Documentation/SubmittingPatches
+
+You can submit your patches to the lxc-devel@lists.linuxcontainers.org mailing
+list. Use http://lists.linuxcontainers.org/listinfo/lxc-devel to subscribe
+to the list.
+
+
+Licensing for new files:
+------------------------
+
+LXC is made of files shipped under a few different licenses.
+
+Anything that ends up being part of the LXC library needs to be released
+under LGPLv2.1+ or a license compatible with it (though the latter will
+only be accepted for cases where the code originated elsewhere and was
+imported into LXC).
+
+Language bindings for the libraries need to be released under LGPLv2.1+.
+
+Anything else (non-libaries) needs to be Free Software and needs to be
+allowed to link with LGPLv2.1+ code (if needed). LXC upstream prefers
+LGPLv2.1+ or GPLv2 for those.
+
+
+When introducing a new file into the project, please make sure it has a
+copyright header making clear under which license it's being released
+and if it doesn't match the criteria described above, please explain
+your decision on the lxc-devel mailing-list when submitting your patch.
 
-http://lxr.linux.no/linux+v2.6.27/Documentation/SubmittingPatches
 
 Developer Certificate of Origin:
 --------------------------------
@@ -77,7 +104,10 @@ By making a contribution to this project, I certify that:
 
 then you just add a line saying
 
-       Signed-off-by: Random J Developer <random@developer.org>
+    Signed-off-by: Random J Developer <random@developer.org>
+
+You can do it by using option -s or --signoff when you commit
+
+    git commit --signoff ...
 
-using your real name (sorry, no pseudonyms or anonymous
-contributions.)
\ No newline at end of file
+using your real name (sorry, no pseudonyms or anonymous contributions.)