Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 946 Bytes

CONTRIBUTING.md

File metadata and controls

47 lines (33 loc) · 946 Bytes

Contributing to Listo

Development

Install the package in editable mode with test dependencies:

pip install -e '.[test]'

Building the project locally

Go to the project root

pip install --upgrade build
python -m build

Test the project, forcing reinstall if necessary

pip install dist/listo-0.1.0-py3-none-any.whl --force-reinstall

Code quality

make lint

Testing

make test

Releasing on PyPI

  1. Update the version in pyproject.toml. We use semantic versioning
  2. Create and merge a PR branch called release-x.x.x
  3. Pull from `main``
  4. At the command line, run make tag
  5. Go to tags page, choose the most recent tag, and click Draft a new release
  6. Click Generate release notes and save
  7. Run make changelog
  8. Use git commit --amend to add the just pulled release notes to the release commit