Contributing to mldsa-native

We welcome contributors who can help us build mldsa-native. If you are interested, please contact us, or volunteer for any of the open issues. Here are some things to get you started.

nix setup

We specify the development environment for mldsa-native using nix. If you want to help develop mldsa-native, please use nix. We recommend using the latest Nix version provided by the nix installer script, but we currently support all Nix versions >= 2.18.

All the development and build dependencies are specified in flake.nix. To execute a bash shell, run

nix develop --experimental-features 'nix-command flakes'

To confirm that everything worked, try lint or tests cbmc.

Coding style

We use auto-formatting using clang-format as specified in .clang-format. Use the ./scripts/format script (in your PATH when usingnix) to re-format the files accordingly.

Namespacing

We namespace all entities of global scope, including statics and structures. This is to facilitate monolithic builds of mldsa-native in a single compilation unit, potentially including multiple copies for different security levels.

Commits and Pull Requests

We require all commits to be signed off using the --signoff flag:

git commit --signoff -m "Your commit message"

This adds a "Signed-off-by" line to your commit message, indicating that you certify the commit under the terms of the Developer Certificate of Origin.