Skip to content

docs: add AGENTS.md agent guidelines + CLAUDE.md pointer - #6

Open
willhea wants to merge 1 commit into
developfrom
docs/agent-guidelines
Open

docs: add AGENTS.md agent guidelines + CLAUDE.md pointer#6
willhea wants to merge 1 commit into
developfrom
docs/agent-guidelines

Conversation

@willhea

@willhea willhea commented Jun 25, 2026

Copy link
Copy Markdown

Summary

Add AGENTS.md (shared agent/contributor guidelines) and a one-line CLAUDE.md pointer to it. No agent-instruction file existed before.

Why

AGENTS.md captures the non-obvious conventions and gotchas an agent or new contributor needs, without restating the README:

  • PRs target develop, not main.
  • The npm audit production gate blocks merges; fix via targeted bump / overrides, never audit fix --force.
  • Color comes from brand CSS-variable tokens, not raw Tailwind palette; diff-op colors in one DIFF_OP_STYLE map.
  • Dark mode is non-functional / being removed (don't add dark:).
  • Diff-engine split (DeltaTrack Python engine ↔ TS fallback), two diff renderers, the ESLint flat-config quirk, MySQL/knex, next-auth v5.

Notes

  • Committed as shared project docs; personal/local Claude state stays in the already-gitignored .claude/.
  • Lean by design — links to the README for spin-up and the full command list.
  • One forward reference: the src/lib/diff-op-styles.ts mention assumes the diff-op token-unification PR has landed.

No agent-instruction file existed. AGENTS.md captures the non-obvious
conventions and gotchas an agent or new contributor needs (PRs target
develop, the npm-audit merge gate, brand-token discipline, the diff-engine
split, the ESLint flat-config quirk, DB-backed build/tests) without
restating the README. CLAUDE.md is a one-line pointer to it.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant