CONTRIBUTING.md

Contribute

Testing

Create Environment

Run these commands just the first time:

# Ensure python3 is installed
python3 -m venv .venv
source .venv/bin/activate
pip install tox "poetry>=1.4"

Enter Environment

Run this command once you open a new shell:

source .venv/bin/activate

Test Your Changes

# test
tox

Release

prev_version=$(poetry version -s)

# Ensure main
git checkout main
git pull

# Version Bump
poetry version minor
# OR
poetry version patch

# Commit, Tag and Push
version=$(poetry version -s)

sed "s/$prev_version/$version/g" -i README.rst
sed "s/$prev_version/$version/g" -i docs/index.rst

git commit -m"version bump to ${version}" pyproject.toml README.rst docs/index.rst
git tag "${version}" -m "Release ${version}"
git push
git push --tags

# Publishing is handled by CI