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