All kinds of bug reports, feature requests or suggestion to improve code are written as issues on this Github repository.
Every push on a branch of repository and pull request to it is guarded by the CI pipeline job. Changes to markdown files in general or files within the folder called "docker" are exceptions to that and will trigger CI checks. The CI performs formatting, linting and unit test checks. If any of this area fail, pull requests will be declined. It's recommended that you start the checks locally before submitting a PR. You can do that by starting the script named "ci_local_check.sh" for local CI checks at the project root. If the script exits with 0 as the return code, the online CI should also succeed on Github.
In this code base there are lines with the prefix "TODO:". These lines are notes about places which should be improved.
Via command on linux systems
grep -nr "TODO:" src/*you can see all the places.
Before submitting run
cargo testSome tests use a crate called Insta to perform snapshot testing. This makes auditing and writing test with complex expected output a lot easier.
If you write an unit test which uses this tool or you change the code in a way which changes the snapshot then you should use the cargo insta plugin to review changed/created snapshots.
You can install this cargo plugin via
cargo install cargo-insta