Skip to content

Latest commit

 

History

History
41 lines (30 loc) · 1.48 KB

File metadata and controls

41 lines (30 loc) · 1.48 KB

Contributing

Thanks for contributing to agentmarkup.

Development Setup

pnpm install
pnpm lint
pnpm test
pnpm typecheck
pnpm build

Repo Layout

  • packages/core contains the framework-agnostic engine.
  • packages/vite contains the publishable @agentmarkup/vite adapter.
  • packages/astro contains the publishable @agentmarkup/astro adapter.
  • website is the dogfooding site and consumes @agentmarkup/vite through the workspace package boundary.
  • examples/vite-react is the minimal consumer example.

Contribution Expectations

  • Keep public docs limited to shipped behavior.
  • Add or update tests for behavior changes.
  • Prefer build-time, deterministic behavior over runtime heuristics.
  • Keep root workspace checks green before opening a commit or PR.

Public vs Internal Docs

  • Public docs live in README.md and this file.
  • Internal planning and tool-specific workflow notes stay out of git.

Website Deployment

  • The website deploy is manual only.
  • Build and publish with ./deploy/website-deploy.sh [cloudflare-project-name].
  • The deploy script runs pnpm install --frozen-lockfile, builds the workspace package plus website, and uploads website/dist to Cloudflare Pages with the workspace-pinned wrangler CLI.
  • CLOUDFLARE_ACCOUNT_ID must be set in the shell before running the deploy script.
  • Cloudflare Pages security headers live in website/public/_headers; keep them aligned with any inline scripts or third-party origins used by the site.