Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (45 loc) · 1.28 KB

CONTRIBUTING.md

File metadata and controls

65 lines (45 loc) · 1.28 KB
Raw

Contributing

Setup

Use the Node version in .node-version and pnpm.

pnpm install
pnpm run hooks:install

The checked-in pre-push hook runs the full verification gate before each push.

Run Locally

Build the package:

pnpm run build

Run the local CLI against a repo that has .vref/manifest.json:

node ./dist/cli.mjs validate --output json
node ./dist/cli.mjs build --check --output json
node ./dist/cli.mjs build
node ./dist/cli.mjs serve

Validation

Run the full repo guardrail:

pnpm run verify

For focused work:

pnpm run check
pnpm run typecheck
pnpm run build
pnpm run smoke
pnpm run test
pnpm run pack:dry

Coverage is reported, not gated — verify does not run it, so a thin patch fails review rather than CI:

pnpm run coverage

Development Notes

Scope and coding boundaries: Repo-Specific Guidance.

Pull Requests

Use Conventional Commit-style titles such as feat(cli): add gallery build command. Include the relevant verification command and any visual reference screenshots or gallery links when UI output changes. Upload screenshots with gh pr comment <n> --attach ./file.png; do not commit them.