CONTRIBUTING.md

Contributing

Setup

1. Clone this repository: git clone https://github.com/thehale/git-authorship

2. Install Python Poetry

   curl -sSL https://install.python-poetry.org | python3 -
   

3. Create a virtual environment and install dependencies

   poetry config virtualenvs.in-project true
   poetry shell
   poetry install
   

4. Run the test suite with pytest to verify that everything works.

5. Have fun with your improvements!

Running Tests

poetry run pytest

Preferences

Please use the Conventional Commits style for your commit messages.

Publishing Updates

poetry config pypi-token.pypi your-api-token
poetry publish --build