Thank you for considering to contribute. You are invited to contribute new features, fixes or updates, large or small. Please raise an issue, to see if a potential feature is in scope of the project. We are always happy to receive contributions and attempt to process them in a timely manner.
To get an overview of what can be worked on, please take a look at the issues. If you are unsure if your contribution fits please reach out for synchronous configuration in the matrix chat room.
For your convenience you only need one tool to contribute to flake-edit or flake-edit: nix.
You can drop into a development shell with:
nix develop
or use direnv:
cat .envrc && direnv allow
We use insta for snapshot testing.
Failing snapshot tests can be reviewed with:
cargo insta review
The benchmarks can be run with:
cargo bench
Please ensure that your machine is in a stable state and not under heavy load when running the benchmarks for accurate and consistent results.
If a dependency is changed, please do remember to update the lock file accordingly.