-
Notifications
You must be signed in to change notification settings - Fork 481
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
38 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
Contributing to liboqs master branch | ||
==================================== | ||
|
||
liboqs has two branches: "master branch", and "nist-branch". | ||
|
||
liboqs master branch focuses on focuses on selected key encapsulations and signature algorithms. Implementations on this branch must beet certain acceptance criteria. | ||
|
||
liboqs nist-branch focuses on incorporating submissions to the NIST Post-Quantum Cryptography standardization project. It takes a "light touch" approach to incorporation. | ||
|
||
Contributing new algorithms | ||
--------------------------- | ||
|
||
The goals and acceptance criteria for new algorithms on liboqs master branch are stated in the README.md. In particular, our goals are to include high quality implementations for which the contributor aims to help with ongoing maintenance. | ||
|
||
To discuss contributing a new algorithm to liboqs master branch, please contact [Douglas Stebila](https://www.douglas.stebila.ca/research/) or post an issue on GitHub for discussion. | ||
|
||
Additional information about contributing code, including coding conventions, can be found on our [GitHub wiki](https://github.com/open-quantum-safe/liboqs/wiki). | ||
|
||
Contributing enhancements | ||
------------------------- | ||
|
||
Contributions to our existing library are gratefully welcomed. If you find a bug in our code, have some improvements to an algorithm, are interested in getting liboqs to build on a new platform, or want to explore integrating liboqs into a new application, please feel free to contact us on GitHub via an issue or pull request. | ||
|
||
Bug reports | ||
----------- | ||
|
||
Bug reports can be filed as issues on GitHub. Please use the "bug" label. Please indicate which branch of liboqs the issue relates to (master or nist-branch), and what platform was in use (CPU, operating system, compiler). | ||
|
||
License | ||
------- | ||
|
||
liboqs is licensed primarily under the MIT License. Submissions to liboqs master branch must be under the MIT License, a compatible license, or in the public domain. See README.md for details. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters