1ab9fc1bdSGreg Tucker# Contributing to ISA-L_crypto 2ab9fc1bdSGreg Tucker 3ab9fc1bdSGreg TuckerEveryone is welcome to contribute. Patches may be submitted using GitHub pull 4ab9fc1bdSGreg Tuckerrequests (PRs). All commits must be signed off by the developer (--signoff) 5ab9fc1bdSGreg Tuckerwhich indicates that you agree to the Developer Certificate of Origin. Patch 6ab9fc1bdSGreg Tuckerdiscussion will happen directly on the GitHub PR. Design pre-work and general 7ab9fc1bdSGreg Tuckerdiscussion occurs on the [mailing list]. Anyone can provide feedback in either 8ab9fc1bdSGreg Tuckerlocation and all discussion is welcome. Decisions on whether to merge patches 9ab9fc1bdSGreg Tuckerwill be handled by the maintainer. 10ab9fc1bdSGreg Tucker 11ab9fc1bdSGreg Tucker## License 12ab9fc1bdSGreg Tucker 13ab9fc1bdSGreg TuckerISA-L_crypto is licensed using a BSD 3-clause [license]. All code submitted to 14ab9fc1bdSGreg Tuckerthe project is required to carry that license. 15ab9fc1bdSGreg Tucker 16ab9fc1bdSGreg Tucker## Certificate of Origin 17ab9fc1bdSGreg Tucker 18ab9fc1bdSGreg TuckerIn order to get a clear contribution chain of trust we use the 19ab9fc1bdSGreg Tucker[signed-off-by language] used by the Linux kernel project. 20ab9fc1bdSGreg Tucker 21ab9fc1bdSGreg Tucker## Mailing List 22ab9fc1bdSGreg Tucker 23ab9fc1bdSGreg TuckerContributors and users are welcome to submit new request on our roadmap, submit 24ab9fc1bdSGreg Tuckerpatches, file issues, and ask questions on our [mailing list]. 25ab9fc1bdSGreg Tucker 26ab9fc1bdSGreg Tucker## Coding Style 27ab9fc1bdSGreg Tucker 28*dcb32c4bSMarcel CornuThe coding style for ISA-L_crypto C code is roughly based on LLVM style with 29*dcb32c4bSMarcel Cornusome customizations. Use the included format script to format C code. 30ab9fc1bdSGreg Tucker 31*dcb32c4bSMarcel Cornu ./tools/format.sh 32ab9fc1bdSGreg Tucker 33ab9fc1bdSGreg TuckerAnd use check format script before submitting. 34ab9fc1bdSGreg Tucker 35ab9fc1bdSGreg Tucker ./tools/check_format.sh 36ab9fc1bdSGreg Tucker 37ab9fc1bdSGreg Tucker[mailing list]:https://lists.01.org/mailman/listinfo/isal 38ab9fc1bdSGreg Tucker[license]:LICENSE 39ab9fc1bdSGreg Tucker[signed-off-by language]:https://01.org/community/signed-process 40