This projects uses the following additional tools:
- cargo_insta: CLI tool to review the changes in the snapshot testing.
- just: as a command runner to automate checks.
- typos: a low positive source code spell checker.
If you want to contribute then make sure to install these tools.
To validate the quality of the code after some changes, execute the following command
just cli
This command checks for following things
- Does the rust code compile ?
- Does the rust code adhere to standard linting rules of clippy ?
- Do all unit tests pass ?
- Are there decteable spelling errors ? It focused on low wrong positive errors. Not all spelling errors will be found
- Is the code formatted according to the rust standard