Skip to content

Contributing guide

Jump to bottom
Michael Baentsch edited this page Jan 22, 2021 · 1 revision

Contributing new quantum-safe application integrations

All submissions must meet acceptance criteria given below. Demos may be removed if they no longer meet the acceptance criteria.

Documentation requirements

  • Purpose of integration and upstream (code origin) location must be clearly documented.
  • README must contain all steps to build the OQS-enabled code.
  • An optional USAGE file must be present if the integration can be built into a docker image.

Execution requirements

  • If possible, a Dockerfile should be provided such as to automate the integration completely. In this case, a separate USAGE file must be available that shall document usage of the docker file at docker hub.
  • If a docker file is provided, it is expected that build-and-test code is added to the continuous integration environment testing (see CCI config).

Maintenance

We hope the contributor will intend to help update the integration over time as the upstream code bases as well as the underlying algorithms and APIs evolve.

Clone this wiki locally