xref: /isa-l_crypto/CONTRIBUTING.md (revision dcb32c4b921d3e13f66c80b6ea64cb957fd8e989)
1# Contributing to ISA-L_crypto
2
3Everyone is welcome to contribute. Patches may be submitted using GitHub pull
4requests (PRs). All commits must be signed off by the developer (--signoff)
5which indicates that you agree to the Developer Certificate of Origin.  Patch
6discussion will happen directly on the GitHub PR. Design pre-work and general
7discussion occurs on the [mailing list]. Anyone can provide feedback in either
8location and all discussion is welcome. Decisions on whether to merge patches
9will be handled by the maintainer.
10
11## License
12
13ISA-L_crypto is licensed using a BSD 3-clause [license]. All code submitted to
14the project is required to carry that license.
15
16## Certificate of Origin
17
18In 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
23Contributors and users are welcome to submit new request on our roadmap, submit
24patches, file issues, and ask questions on our [mailing list].
25
26## Coding Style
27
28The coding style for ISA-L_crypto C code is roughly based on LLVM style with
29some customizations. Use the included format script to format C code.
30
31    ./tools/format.sh
32
33And use check format script before submitting.
34
35    ./tools/check_format.sh
36
37[mailing list]:https://lists.01.org/mailman/listinfo/isal
38[license]:LICENSE
39[signed-off-by language]:https://01.org/community/signed-process
40