Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (33 loc) · 1.08 KB

CONTRIBUTING.md

File metadata and controls

46 lines (33 loc) · 1.08 KB
Raw

Contributing

Setup

git clone https://github.com/RijksICTGilde/zad-cli.git
cd zad-cli
uv sync
uv run pre-commit install

Development

uv run zad --help          # Run the CLI
uv run pytest              # Run tests
uv run ruff check .        # Lint
uv run ruff format .       # Format

Testing

All tests run without a real API connection. Uses respx for httpx mocking and tmp_path for filesystem tests.

uv run pytest -v                                    # All tests
uv run pytest tests/test_client.py                   # Single file
uv run pytest tests/test_client.py::test_retry_on_500  # Single test

Commit messages

Use Conventional Commits:

  • feat: new feature (bumps minor version)
  • fix: bug fix (bumps patch version)
  • chore: maintenance (no version bump)
  • docs: documentation (no version bump)
  • test: tests (no version bump)

CI enforces this format on all PR commits. Use feat!: or add a BREAKING CHANGE: footer for breaking changes (bumps minor while pre-1.0).

License

EUPL-1.2