Documentation
README
Push & Release
Push code to GitHub. If the pending commits contain feature changes, bump the version number so CI auto-publishes to PyPI.
Workflow
-
Check working tree: Ensure no uncommitted changes (prompt user to commit first if dirty).
-
Determine whether a version bump is needed:
- Read current version from
pyproject.toml - Run
git log origin/main..HEAD --onelineto inspect pending commits - If commits include feature changes (feat/fix/refactor, not purely docs/chore/test), a bump is needed
- If only docs, tests, or CI changes, skip the bump
- Read current version from
This is the opening of the README. Read the full README on GitHub.