Skip to content

Latest commit

 

History

History
24 lines (15 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

24 lines (15 loc) · 1.4 KB

Contributing

Thanks for helping build Dock.

Before you start

Contributor License Agreement

Every contributor signs the Dock CLA. Signatures are stored per repository, so the CLA bot asks on your first pull request in each repository; reply with the sentence it gives you to sign. You keep the copyright in your work.

Development

Set up with python -m venv .venv && .venv/bin/pip install -e ".[dev]", then run ruff check . && ruff format --check . && mypy && pytest. The SDK is written by hand and only exposes public routes. Every change runs the shared scenario suite from usedock/dock (sdk-scenarios/, pinned in SCENARIOS_REF; point DOCK_SCENARIOS_DIR at a checkout). When a scenario changes upstream, bump SCENARIOS_REF in the same pull request.

Pull requests

  • One change per pull request, with tests.
  • Conventional commit titles: feat(scope): ..., fix(scope): ..., docs: ....
  • Short comments only where the why is not obvious; no emojis in code, comments or commits.
  • A maintainer reviews every pull request before merge.