]> git.proxmox.com Git - mirror_lxc.git/blob - CONTRIBUTING
Add the lxc-cgroup man page
[mirror_lxc.git] / CONTRIBUTING
1
2 Contributing to this project
3 ----------------------------
4
5
6 This project accepts contributions. In order to contribute, you should
7 pay attention to a few things:
8
9 1 - your code must follow the coding style rules
10 2 - the format of the submission must be email patches
11 3 - your work must be signed
12
13
14 Coding Style:
15 -------------
16
17 The coding style follows the Linux kernel coding style.
18
19 The coding style is defined in the 'CodingStyle' file, available in
20 the directory 'Documentation' of the Linux kernel source tree.
21
22 It can be accessible online too:
23
24 http://lxr.linux.no/linux+v2.6.27/Documentation/CodingStyle
25
26 Submitting Modifications:
27 -------------------------
28
29 The contributions should be email patches. The guidelines are the same
30 as the patch submission for the Linux kernel except for the DCO which
31 is defined below. The guidelines are defined in the
32 'SubmittingPatches' file, available in the directory 'Documentation'
33 of the Linux kernel source tree.
34
35 It can be accessible online too:
36
37 http://lxr.linux.no/linux+v2.6.27/Documentation/SubmittingPatches
38
39 Developer Certificate of Origin:
40 --------------------------------
41
42 To improve tracking of contributions to this project we will use a
43 process modeled on the modified DCO 1.1 and use a "sign-off" procedure
44 on patches that are being emailed around or contributed in any other
45 way.
46
47 The sign-off is a simple line at the end of the explanation for the
48 patch, which certifies that you wrote it or otherwise have the right
49 to pass it on as an open-source patch. The rules are pretty simple:
50 if you can certify the below:
51
52 By making a contribution to this project, I certify that:
53
54 (a) The contribution was created in whole or in part by me and I have
55 the right to submit it under the open source license indicated in
56 the file; or
57
58 (b) The contribution is based upon previous work that, to the best of
59 my knowledge, is covered under an appropriate open source License
60 and I have the right under that license to submit that work with
61 modifications, whether created in whole or in part by me, under
62 the same open source license (unless I am permitted to submit
63 under a different license), as indicated in the file; or
64
65 (c) The contribution was provided directly to me by some other person
66 who certified (a), (b) or (c) and I have not modified it.
67
68 (d) The contribution is made free of any other party's intellectual
69 property claims or rights.
70
71 (e) I understand and agree that this project and the contribution are
72 public and that a record of the contribution (including all
73 personal information I submit with it, including my sign-off) is
74 maintained indefinitely and may be redistributed consistent with
75 this project or the open source license(s) involved.
76
77
78 then you just add a line saying
79
80 Signed-off-by: Random J Developer <random@developer.org>
81
82 using your real name (sorry, no pseudonyms or anonymous
83 contributions.)