Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
16 lines (14 loc) · 1.04 KB

CONTRIBUTING.md

File metadata and controls

16 lines (14 loc) · 1.04 KB
Raw

Contributing

Thanks for helping. deploy-this is small on purpose; please keep it that way.

  • Set up: python3 -m venv .venv && . .venv/bin/activate && pip install -e '.[dev]'.
  • Before a PR: ruff check . && ruff format . && mypy && pytest. Live Caddy tests run with DEPLOY_THIS_TEST_CADDY=/path/to/caddy pytest -m caddy (needs openssl).
  • Commits: Conventional Commits (feat:, fix:, docs:, test:, refactor:, ci:, chore:).
  • Dependencies: permissive licenses only (MIT/BSD/Apache); runtime deps stay minimal.
  • Hygiene: no real hostnames, IPs, organisation names or ticket references — use example.internal-style placeholders in code, docs, tests and commits.
  • Design changes: if you touch routing, the helper, or the deploy sequence, update docs/design.md (including the failure stories) in the same PR.
  • The helper (src/deploy_this/helper.py) must stay a single stdlib-only file with exactly four verbs; tests/test_helper.py enforces the import rule.