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