kris/pqcrypto
1
1
Fork 0
mirror of https://github.com/henrydcase/pqc.git synced 2024-11-26 09:21:28 +00:00
Code Issues 1 Releases Wiki Activity

Syntax typos

Browse Source
This commit is contained in:
Thom Wiggers 2019-02-27 14:19:51 +01:00
parent 928b92364e
commit 7d8b12d6bd
No known key found for this signature in database
GPG Key ID: 001BB0A7CE26E363
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
CONTRIBUTING.md
View File

@ -11,7 +11,7 @@ Also, we apply static and dynamic analysis tools.
For this text, we will assume that you want to contribute a **kem** to PQClean. For this text, we will assume that you want to contribute a **kem** to PQClean.
For a signature scheme, these steps are equivalent, but the API is slightly different. For a signature scheme, these steps are equivalent, but the API is slightly different.
See the section [API][#API] below. See the section [API](#API) below.
1. Fork our repository. You will be creating a pull request soon. 1. Fork our repository. You will be creating a pull request soon.
**Tip:** Do not wait until you think you have gotten everything perfect, before you open the pull request. **Tip:** Do not wait until you think you have gotten everything perfect, before you open the pull request.
@ -41,12 +41,16 @@ implementations:
This file needs to be valid [YAML](https://yaml.org/). This file needs to be valid [YAML](https://yaml.org/).
4. Put your scheme into ``crypto_kem/yourschemename/clean``. 4. Put your scheme into ``crypto_kem/yourschemename/clean``.
1. Make sure all symbols are prefixed with ``PQCLEAN_YOURSCHEME_CLEAN_`` 1. Make sure all symbols are prefixed with ``PQCLEAN_YOURSCHEME_CLEAN_``
2. Include ``api.h`` into your scheme with the symbols specified in the section [API][#API]: 2. Include ``api.h`` into your scheme with the symbols specified in the section [API](#API):
5. Create ``Makefile`` and ``Makefile.Microsoft_nmake`` files to compile your scheme as static library. 5. Create ``Makefile`` and ``Makefile.Microsoft_nmake`` files to compile your scheme as static library.
* We suggest you take these from ``crypto_kem/kyber768/clean`` and modify them to suit your scheme. * We suggest you take these from ``crypto_kem/kyber768/clean`` and modify them to suit your scheme.
6. Add a ``LICENSE`` file to your implementation folder. 6. Add a ``LICENSE`` file to your implementation folder.
7. Commit everything and push it to your fork 7. Commit everything and push it to your fork
8. Open a pull request on our repository and process the feedback given to you by the CI environment. 8. Open a pull request on our repository and process the feedback given to you by the CI environment.
The pull request will also set up a checklist for you and us to follow. The pull request will also set up a checklist for you and us to follow.