Workflow & Checklists

Use this workflow to align with the build pipeline, keep changes accessible, and avoid regressions.

Pre-flight Checklist

  • Review the relevant specs before editing code or content.
  • Identify which surfaces you are touching (/app, /worker, /content, /docs).
  • Confirm you understand required commands and testing expectations in Required Commands.
  • Keep a clean working tree—do not commit generated build artifacts.

Build System Details

  • Primary build command: bun run build (Astro build + sitemap output).
  • Worker bundle: built alongside the site so API routes remain type-checked.
  • Local preview: bun run dev for the site, bun run dev:worker when you need Worker bindings.

Testing Requirements

  • Smoke tests: bun run test (prepares builds once, then runs smoke/worker + content checks).
  • Unit tests: bun run test:unit:fast for quick iteration loops.
  • E2E tests: bun run test:e2e for navigation, forms, and layout changes.
  • Full verification: bun run verify to mirror CI before merging.

Automating Regulatory Research Updates

Use an agentic loop so compliance research stays current without manual copy-paste:

  1. Source sweep: collect updates from primary regulators/standards sources and log links in the active task branch.
  2. Delta classification: label each update as timeline change, obligation change, guidance clarification, or no-op.
  3. Patch generation: let the agent draft page/content updates and a concise changelog note in one commit.
  4. Human gate: require reviewer sign-off on legal interpretation before merge.
  5. Verification: run bun run verify before opening the PR.

This keeps governance content operational even when policy schedules shift mid-cycle.

Local Setup

  1. Install dependencies and prepare local environment variables: 
    bun run setup
  2. Start Astro with hot reload: 
    bun run dev
  3. When Worker bindings are required: 
    bun run dev:worker

Deployment

  • Run bun run verify before pushing release-ready changes.
  • Use the repo-pinned Wrangler version (bunx wrangler) during deployment workflows.
  • Confirm social card assets are present in app/dist/assets/ after builds.

Getting Help

  • Troubleshoot build and test issues in the Troubleshooting Playbook.
  • If tests fail, check the relevant guide in /docs before adjusting code.
  • Document any new pitfalls or workflows in /docs/agents/ so the guidance stays current.