Skip to content

Contributing

The project is developed on the stable branch. Bug reports and pull requests go to github.com/jamstackpy/jamstack.

Local setup

git clone git@github.com:jamstackpy/jamstack.git
cd jamstack
git switch stable
python -m venv .venv
. .venv/bin/activate
pip install -e ".[dev]"
pre-commit install --hook-type pre-commit --hook-type commit-msg

Checks

ruff check .
ruff format --check .
pytest

The same checks run in CI on Python 3.11 through 3.14. A pull request that changes behaviour needs a test that would fail without the change.

Commits

Commits follow Conventional Commits in English:

feat(cli): add a --drafts flag to build
fix(content): reject dates without a year
docs: explain local theme overrides

One commit is one reviewable intention. Put mechanical changes (renames, formatting, dependency bumps) in their own commit, and do not leave intermediate commits that fail the tests. When the change needs context, add a bullet-point body explaining what and why.

commitizen validates the message through the commit-msg hook.

Pull requests

  • Target stable.
  • Keep user-facing text and documentation in English.
  • Do not rewrite pushed history.

The full guide, including the release process, lives in CONTRIBUTING.md.