Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
26 lines (19 loc) · 1.06 KB

CONTRIBUTING.md

File metadata and controls

26 lines (19 loc) · 1.06 KB
Raw

Contributing

Branching

Branch off main. For work tracked as a Linear issue — most of it — use the branch name Linear generates: cl-<issue-number>-<slug>. Otherwise, use <type>/<short-description> (e.g. fix/settings-write-race, feat/build-worker-setting), the form this repo's merged history otherwise uses.

Opening a pull request

Open the PR against main. bun run check runs in CI on every pull request (see .github/workflows/check.yml) and must pass before the PR is merged; run it locally first (see AGENTS.md for what it covers).

Commit messages

Follow Conventional Commits 1.0.0 (https://www.conventionalcommits.org/en/v1.0.0/).

  • Format: <type>(<scope>): <description> — scope is the component, e.g. feat(executor), fix(nameref), perf(glob), docs(release).
  • Types: feat, fix, perf, refactor, test, docs, build, ci, chore, style. Breaking changes: append ! after the type/scope or add a BREAKING CHANGE: footer.
  • Never add a Co-Authored-By trailer to any commit, PR, gh issue, or any other artifact