Skip to content

CONTRIBUTING.md

Latest commit

聽

History

History
47 lines (29 loc) 路 1.24 KB

CONTRIBUTING.md

File metadata and controls

47 lines (29 loc) 路 1.24 KB
Raw

How to contribute

Dependencies

We use uv to manage Inseq dependencies. If you dont have uv, you should install with make uv-download.

To install dependencies and prepare pre-commit hooks you would need to run install command:

make install

or

make install-dev

To activate your virtualenv run make uv-activate.

Codestyle

After installation you may execute code formatting.

make lint

Checks

Many checks are configured for this project. Command make check-style will check style with ruff. The make check-safety command will look at the security of your code.

Comand make lint applies all checks.

Before submitting

Before submitting your code please do the following steps:

  1. Add any changes you want
  2. Add tests for the new changes
  3. Edit documentation if you have changed something significant
  4. Run make fix-style to format your changes.
  5. Run make lint to ensure that types and security are okay.

Other help

You can contribute by spreading a word about this library. It would also be a huge contribution to write a short article on how you are using this project. You can also share your best practices with us.