Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
32 lines (21 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

32 lines (21 loc) · 1.89 KB
Raw

Contributing to Contractual

All development targets next, the schema lifecycle implementation. master contains the previous code-generation product.

git fetch origin
git switch -c fix/describe-the-change origin/next
pnpm install --frozen-lockfile
pnpm build

Use Node 22 or newer and pnpm 9.15.4. Before opening a PR, run:

pnpm lint
pnpm test
pnpm test:e2e

These commands validate source and behavior. CI runs them on Node 22, 24, and 26. Normal CI never publishes or tags. Use existing GitHub Actions and native workflow commands, without a separate scripts folder or custom package-verification action.

Open a PR to next

Use a Conventional Commit title: fix(cli): handle missing snapshots, feat(differs.core): classify new constraints, or docs: clarify supported formats. Supported types are feat, fix, docs, style, refactor, perf, test, build, ci, chore, and revert. Use ! before the colon for a breaking change.

One approving review, resolved conversations, an up-to-date branch, and passing CI and PR title checks are required. PRs are squash merged, with the PR title used as the commit subject. The ruleset is managed directly in the repository's GitHub settings; no ruleset JSON file is needed.

Scopes must match a workspace package: cli, changesets, types, governance, differs.core, differs.json-schema, or differs.openapi. Use * for changes across packages or omit the scope for repository-wide changes. The semantic PR action enforces this allowlist; update both its workflow configuration and the repository ruleset when adding or renaming a package.

Release approval

Normal development never publishes packages or creates version tags. Ask Omer before tagging, publishing, changing npm distribution tags, or dispatching a release workflow. See RELEASING.md for the release procedure and current support boundary.