CONTRIBUTING.md

How to contribute?

Setting up dev environment

Essentials:

• Install rust.
• Install just.

Building this project

Run in your terminal:

just build

Running tests

Run in your terminal:

just test

Running code quality checks

Audit project dependencies

Run in your terminal:

just audit

Generate code coverage report

Run in your terminal:

just coverage

This will generate HTML code coverage report in the target/tarpaulin.

Lint

Run in your terminal:

just lint

Checking how tool will work on the end-user machine

Run in your terminal:

just install

This will install checkmark on your PC.

Git Workflow

Branching model: Trunk Based Development. Commit message convention: Conventional Commits. Branch name convention: Use same prefix as for the Conventional Commits, use short descriptive name of the branch, for ex. feat/add-support-of-new-rule.

Known Issues & Workarounds

Error compiling rust-openssl on Windows

If you see this error:

Can't locate Locale/Maketext/Simple.pm in @INC (you may need to install the Locale::Maketext::Simple module)

then it means that perl needs additional configuration. Have a look how it is set up in GitHub Workflow. More information here.