pq-code-package / mlkem-native

High-assurance, high-performance ML-KEM implementation for mobile, pc, and server targets
https://pq-code-package.github.io/mlkem-native/dev/bench/
Apache License 2.0
11 stars 9 forks source link

Prepare documentation for alpha-release #427

Open mkannwischer opened 3 days ago

mkannwischer commented 3 days ago

The following files should be updated prior to a alpha release:

Let's track the progress here. Some are straight-forward, some need some thinking (PR templates, issue templates), for some we can maybe ask for help from the PQCP TSC.

Please let me know if you think I missed something. @hanno-becker any other documentation you think we definitely need? We definitely need some text describing the release (see e.g., https://github.com/open-quantum-safe/liboqs/releases/tag/0.11.0).

@planetf1, could you maybe help us with making sure that we are not missing anything? I don't quite fully understand yet what should be part of CODE_OF_CONDUCT.md, CONTRIBUTING.md, GOVERNANCE.md, SECURITY.md, SUPPORT.md and which are strictly required. I'd stay close to liboqs for now.