Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
28 lines (22 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

28 lines (22 loc) · 1.29 KB
Raw

Contributing

Thanks for your interest in Corbits Triage.

vendor/interchange is vendored code. Do not open a PR that changes anything under vendor/interchange unless it adds a ledgered upstream delta. See VENDORED.md for the ledger and propose changes upstream at faremeter/interchange.

Before you start

  • Contributions are accepted under the terms of the Contributor License Agreement and the project license, GPLv2 with AI Exception.
  • docs/DEV.md covers local setup, including the GitHub emulator.
  • AGENTS.md, and the AGENTS.md files under apps/ and packages/, hold the architecture and code rules every change follows, whether a person or a coding agent writes it.

The short version

  1. bun run check and bun run test must be green before and after your change.
  2. One logical change per commit; write messages for a public audience.
  3. Never commit secrets. .env.example is the only tracked env file.
  4. Never vendor code without a ledger row and kill date in VENDORED.md; sh tooling/vendor-diff-check.sh enforces it.
  5. Security issues go through SECURITY.md, never a public issue.