Skip to content

Latest commit

 

History

History
34 lines (23 loc) · 810 Bytes

CONTRIBUTING.md

File metadata and controls

34 lines (23 loc) · 810 Bytes

Contributing

Thanks for contributing to aw-index-cli!

Development setup

Install the package in editable mode with the dev extras (pytest):

python3 -m pip install -e ".[dev]"

Running the tests

pytest

Pre-commit

Formatting and linting run via pre-commit. Install the hooks once; they then run on every commit:

pre-commit install
pre-commit run --all-files   # or run against the whole repo on demand

Commit and PR conventions

  • Write commit messages and PR titles as Conventional Commits (e.g. feat(compose): …, fix(cli): …, docs: …).
  • Sign off every commit for the DCO by adding a Signed-off-by trailer with git commit -s.