This document contains guidelines and instructions on how best to contribute to Facti.
If you have any questions, do not be afraid to reach out to us and ask!
Your best option is using GitHub discussions or joining the Matrix room to chat with us directly.
If for some reason you feel like you want a more private discussion,
please refer to the AUTHORS file for contact information.
If you use VS Code (or derivatives) with rust-analyzer, the included settings file will enable automatic formatting when you save files and paste code.
When you open the project in VS Code it will suggest to install the relevant extensions if you haven't already. If you're using other editors or IDEs you will have to make sure to install rust-analyzer in whatever way is relevant for your environment.
In general, just format the code however rustfmt wants you to format it.
If you have questions about the formatting or suggestions on possible improvements by deviating from the defaults, please start a discussion about it and we can take it further from there!
All of this is of course verified by CI when you make a pull request, so it's always possible to discuss and resolve issues at that stage. But the more things you verify before making your PR, the smoother it will go!
Follow whatever rustfmt says, and format your code with it.
If you don't have it, you can add it with rustup:
rustup component add rustfmt
Then run it on the code:
cargo fmt
(If you're using VS Code or other supported editors this will be done for you.)
Make sure to run cargo clippy and fix any issues it finds. (No need to run
cargo check separately.)
If you don't have clippy, you can add it with rustup:
rustup component add clippy
Add tests to verify new features! And make sure to run existing tests to make sure nothing broke with your changes!
cargo test
Nobody is expecting 100% code coverage, of course, but try to add tests that are relevant for your changes when you can.
Please make sure to update the relevant changelog(s) if you contribute to Facti!
They can be found in the root of each crate:
Facti follows the keep a changelog specification.