Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (30 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

42 lines (30 loc) · 1.19 KB

Contributing

Contributions are welcome. Feel free to open an issue in our issue tracker and/or create a pull request.

Local Development

You need a Python interpreter and uv installed. Then simply run

uv venv  # to setup your virtual environment
uv sync --extra dev  # to install all dependencies
uv run pytest  # to run all unit tests

To run a development version of a script for testing eg. a hook on another repo, run:

uv sync # to install current scripts in a virtualenv
source .venv/bin/activate # to activate the virtualenv
# And then eg.
cd <another_repo>
check-ownership file1 file2

An alternative to the above is to run:

pip3 install -e .

That will install the tools in editable mode, meaning that your code changes will be visible as soon as you run the scripts again.

Creating a release

To release a new version of dev-tools:

  1. update the pyproject.toml version field,
  2. put up a PR and get it merged to master,
  3. once merged, create a tag with the same version and push it,
  4. a release pipeline will run automatically and push a release.