Skip to content

Latest commit

 

History

History
19 lines (15 loc) · 865 Bytes

CONTRIBUTING.md

File metadata and controls

19 lines (15 loc) · 865 Bytes
Raw

Contributors Guide

  1. Open an issue indicating what you would like to do
  2. Clone the repo at https://github.com/jfcrenshaw/photerr
  3. Install poetry
  4. Create a new branch of the repository and run
poetry install
poetry run pre-commit install
poetry run pre-commit autoupdate
  1. Begin development!
  2. Submit a pull request. There are a number of things you should check:
    • Make sure you bump the semantic version number.
    • Before merging, rebase your branch and squash all of your commits into one or two clear commits. This is to keep the version history clean and linear. You can also use Github's "squash and merge" option.
  3. After merging your changes, create a new release on Github. Make sure you include a description of the changes, as I use the release page to track changes.