]>
Commit | Line | Data |
---|---|---|
224ce89b WB |
1 | # Contributing to ISA-L |
2 | ||
3 | Everyone is welcome to contribute. Patches may be submitted using GitHub pull | |
4 | requests (PRs). All commits must be signed off by the developer (--signoff) | |
5 | which indicates that you agree to the Developer Certificate of Origin. Patch | |
6 | discussion will happen directly on the GitHub PR. Design pre-work and general | |
7 | discussion occurs on the [mailing list]. Anyone can provide feedback in either | |
8 | location and all discussion is welcome. Decisions on whether to merge patches | |
9 | will be handled by the maintainer. | |
10 | ||
11 | ## License | |
12 | ||
13 | ISA-L is licensed using a BSD 3-clause [license]. All code submitted to | |
14 | the project is required to carry that license. | |
15 | ||
16 | ## Certificate of Origin | |
17 | ||
18 | In order to get a clear contribution chain of trust we use the | |
19 | [signed-off-by language] used by the Linux kernel project. | |
20 | ||
21 | ## Mailing List | |
22 | ||
23 | Contributors and users are welcome to submit new request on our roadmap, submit | |
24 | patches, file issues, and ask questions on our [mailing list]. | |
25 | ||
26 | ## Coding Style | |
27 | ||
28 | The coding style for ISA-L C code roughly follows linux kernel guidelines. Use | |
29 | the included indent script to format C code. | |
30 | ||
31 | ./tools/iindent your_files.c | |
32 | ||
f91f0fd5 TL |
33 | And use check format script before submitting. |
34 | ||
35 | ./tools/check_format.sh | |
36 | ||
37 | [mailing list]:https://lists.01.org/hyperkitty/list/isal@lists.01.org/ | |
224ce89b WB |
38 | [license]:LICENSE |
39 | [signed-off-by language]:https://01.org/community/signed-process |