Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
32 lines (24 loc) · 808 Bytes

CONTRIBUTING.md

File metadata and controls

32 lines (24 loc) · 808 Bytes
Raw

Contributing

Thanks for helping improve this gateway.

Local workflow

  1. Bootstrap and start the gateway:
./headway init
./headway up
  1. Make your changes.
  2. Re-run validation:
./headway secret-scan
./headway test
./headway doctor

Expectations

  • Keep changes small and focused.
  • Preserve stable routing behavior:
    • Copilot/OpenAI lane: Client -> Headroom (:4000) -> LiteLLM (:4001)
    • Bedrock native lane: Client -> Headroom (:4002) -> headroom-bedrock (:8787) -> AWS Bedrock
  • Do not commit secrets or runtime cache/state files.
  • Keep README/AGENTS docs in sync with behavior changes.
  • Open PRs against main; branch protection requires passing CI before merge.
  • For same-repo PRs, CI may auto-commit formatting fixes (shfmt, ruff format) to your branch.