]> git.proxmox.com Git - mirror_lxc.git/blobdiff - CONTRIBUTING
spelling: output
[mirror_lxc.git] / CONTRIBUTING
index 16e2b7272260b82958ecc39cb20383221fcbd26c..6a3155db4285f9a189cdb972487cfe060acace50 100644 (file)
@@ -5,36 +5,28 @@ 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 Github pull requests
+    2 - the format of the submission must be GitHub pull requests
     3 - your work must be signed
 
 
 Coding Style:
 -------------
 
-The coding style follows the Linux kernel coding style.
+The LXC project generally follows the Linux kernel coding style.  However there
+are a few differences, these are outlined it CODING_STLYE.md
 
-The coding style is defined in the 'CodingStyle' file, available in
-the directory 'Documentation' of the Linux kernel source tree.
+The Linux kernel coding style guide can be found within the kernel tree:
+
+       Documentation/process/coding-style.rst
 
 It can be accessed online too:
 
-https://www.kernel.org/doc/html/v4.10/process/coding-style.html
+https://www.kernel.org/doc/html/latest/process/coding-style.html
 
 Submitting Modifications:
 -------------------------
 
-The contributions must be Github pull requests.
-It is also possible to send contributions as email patches. But please be aware
-that the review process might take significantly longer than in the case of
-Github pull requests. You can submit your email patches to the
-lxc-devel@lists.linuxcontainers.org mailing list. (Use
-http://lists.linuxcontainers.org/listinfo/lxc-devel to subscribe to the list.)
-The guidelines for submitting email patches 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:
-https://www.kernel.org/doc/html/v4.10/process/submitting-patches.html
+The contributions must be GitHub pull requests.
 
 Licensing for new files:
 ------------------------
@@ -48,7 +40,7 @@ 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
+Anything else (non-libraries) 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.
 
@@ -61,9 +53,7 @@ Developer Certificate of Origin:
 --------------------------------
 
 To improve tracking of contributions to this project we will use a
-process modeled on the modified DCO 1.1 and use a "sign-off" procedure
-on patches that are being emailed around or contributed in any other
-way.
+process modeled on the modified DCO 1.1 and use a "sign-off" procedure.
 
 The sign-off is a simple line at the end of the explanation for the
 patch, which certifies that you wrote it or otherwise have the right