Skip to content

AGENTS.md

Latest commit

 

History

History
43 lines (30 loc) · 2.56 KB

AGENTS.md

File metadata and controls

43 lines (30 loc) · 2.56 KB
Raw

Repository Guidelines

Commit Rules

  • Use English conventional commits, for example feat: reorganize source layout.
  • Do not commit until bun run lint, bun run format:check, bun run typecheck, bun run test:coverage, and bun run build all pass.
  • Unit test coverage must stay at or above 90%; do not commit code below the enforced coverage threshold.

Code Style

  • Write comments in English only.
  • Keep README, deployment manifests, GitHub Actions, and Dependabot aligned with the current repository structure.
  • Prefer Bun for dependency management and local commands.
  • Prefer TypeScript for application and test code whenever a new file or rewrite is needed.
  • Use arrow functions only. Do not introduce function declarations; prefer const name = () => {} consistently.
  • Do not leave unused variables in committed code. Remove them or rename intentionally ignored values with a leading underscore only when the linter rule allows it.
  • When changing user-visible copy, review every supported locale in messages/ and keep equivalent wording aligned across them.

Verification Before Commit

  • Run bun run lint.
  • Run bun run format:check.
  • Run bun run typecheck.
  • Treat unit test coverage below 90% as a blocking failure.
  • Run bun run test:coverage and confirm the reported coverage stays at or above 90%.
  • Run bun run build.

Verification Before PR

  • Run bun run test:ci to generate coverage/lcov.info and test-report.junit.xml.
  • Run bun run test:patch-branches --base "$(git merge-base HEAD origin/main)" after coverage; changed branch coverage must be at least 90%.
  • Confirm Codecov's patch status is successful and meets the target configured in codecov.yml; do not lower the patch target or threshold to bypass a coverage failure.
  • Use the Codecov PR report as the source of truth for patch coverage because it compares the uploaded lcov.info against the PR base commit.

This is NOT the Next.js you know

This version has breaking changes — APIs, conventions, and file structure may all differ from your training data. Read the relevant guide in node_modules/next/dist/docs/ (resolved from this file's directory; in monorepos the next package may not be visible from the repo root) before writing any code. Heed deprecation notices.

This block is written and re-added by next dev — verify at node_modules/next/dist/server/lib/generate-agent-files.js. Removing it from a diff only re-creates the uncommitted change; committing it with your work keeps the tree clean.