Skip to content

Latest commit

 

History

History
33 lines (24 loc) · 822 Bytes

CONTRIBUTING.md

File metadata and controls

33 lines (24 loc) · 822 Bytes

contributing

Building the package

This project uses pipx to run other Python-based CLIs. Follow https://github.com/pypa/pipx#install-pipx to install it.

Then run the following.

make build install

Releasing

  1. Create a pull request with a version bump.
bin/create-release-pr '0.6.0'
  1. Merge that PR.
  2. navigate to https://github.com/jameslamb/pydistcheck/releases
  3. edit the draft release there
    • remove any changelog items that are just "changed the version number" PRs
    • ensure that the tag that'll be created matches the version number, in the form v{major}.{minor}.{patch}
  4. click "publish"
    • when that happens, CI jobs will run that automatically publish the package to PyPI.
  5. Open another PR bumping the version
bin/create-version-bump-pr