Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (40 loc) · 1.9 KB

CONTRIBUTING.md

File metadata and controls

59 lines (40 loc) · 1.9 KB
Raw

Contributing

This repository uses a monorepo layout (apps/*, packages/*) with tests and linting enforced before merge.

General Workflow

  1. Create a focused branch for your issue.
  2. Keep changes scoped and reviewable.
  3. Add or update tests with behavior changes.
  4. Run checks locally before opening a PR:
npm run test
npm run lint
npm run build
  1. Link the PR to the relevant issue.

Visual Regression Baselines (Deployment Preview)

Visual regression baselines for deployment preview templates are stored in:

  • apps/backend/tests/visual/baselines/deployment-preview/dex.baseline.json
  • apps/backend/tests/visual/baselines/deployment-preview/defi.baseline.json
  • apps/backend/tests/visual/baselines/deployment-preview/payment.baseline.json
  • apps/backend/tests/visual/baselines/deployment-preview/asset.baseline.json

Compare Baselines

Run this in default mode to validate that generated screenshots remain within the allowed diff threshold:

npm run --workspace @craft/backend test -- tests/visual/preview.visual.test.ts

CI runs the same compare path in .github/workflows/visual-regression.yml. Any diff over threshold fails the job.

Update Baselines

When intentional visual changes are made to deployment preview templates, regenerate and commit updated baselines:

VISUAL_BASELINE_MODE=store npm run --workspace @craft/backend test -- tests/visual/preview.visual.test.ts

On Windows PowerShell:

$env:VISUAL_BASELINE_MODE='store'
npm run --workspace @craft/backend test -- tests/visual/preview.visual.test.ts
Remove-Item Env:VISUAL_BASELINE_MODE

PR Expectations

  1. Include before/after screenshots for each affected template category (dex, defi, payment, asset).
  2. Keep baseline-only updates in small, reviewable commits.
  3. Ensure baseline-missing failures are not bypassed; tests should fail with a clear missing-baseline message.