Skip to content

docs: add AGENTS.md for coding agents - #319

Merged
ianmiell merged 1 commit into
mainfrom
docs/agents-md
Oct 1, 2026
Merged

ianmiell merged 1 commit into
mainfrom
docs/agents-md

Conversation

@ianmiell

@ianmiell ianmiell commented Oct 1, 2026

Copy link
Copy Markdown
Contributor

Adds AGENTS.md, guidance for coding agents (Claude Code, Codex, Copilot, Cursor), plus a one-line CLAUDE.md (@AGENTS.md) so Claude Code loads it.

It covers what isn't obvious from the code:

  • the commands CI runs (make reviewable, a single spec with npx vitest run, VITE_API_URL for local-dev);
  • API client traps: deep camelCasing of every response (and how camelcaseStopPaths paths work), decamelizeKeys producing kebab-case, useDataApi unwrapping {data}, binary responses;
  • conventions: <script setup lang="ts">, explicit imports, hand-written types, vendored src/volt, LabelList.vue hiding _ labels;
  • test pitfalls: call-order-dependent view specs, jsdom gaps, declaring a computed before a watch that reads it.

Other changes

  • Removes .prettierrc.json. Prettier never read it. When both exist, the prettier key in package.json wins (npx prettier --find-config-path src/main.ts reports package.json), and that is the style the code follows: semicolons and trailing commas. The two configs disagreed (.prettierrc.json said no semicolons, printWidth: 100), so the stray file misled people and agents into reformatting to the wrong style. It was left over from the initial scaffold (Dec 2024); the package.json key replaced it in Jan 2025. prettier --check src/ still passes without it, so nothing is reformatted. If a standalone config file is preferred, the package.json settings can be moved into .prettierrc.json instead; what matters is having only one.
  • Lowers make dev's Node check from 21 to 20, matching engines and CI.
  • Removes tests/setup.ts, which nothing references (vitest uses vitest.setup.ts).
  • Replaces a machine-specific absolute path in docs/TOOLTIPS.md.

make reviewable passes (1116 tests). A fresh agent given only CLAUDE.md planned a UI change correctly; the gaps it hit (stop-path syntax, LabelList.vue) are covered.

Companion PRs: compliance-framework/api#467 and compliance-framework/agent#98.

🤖 Generated with Claude Code

AGENTS.md covers the commands CI runs, the layout, the API client traps
(deep camelCasing, stop paths, kebab-case decamelizeKeys, envelope
unwrapping, binary responses), conventions and test pitfalls. CLAUDE.md
imports it for Claude Code.

Also:
- Remove .prettierrc.json. Prettier never read it: when both exist, the
  "prettier" key in package.json wins (prettier --find-config-path
  reports package.json), and that is the style the code follows
  (semicolons, trailing commas). The two disagreed (.prettierrc.json said
  no semicolons, printWidth 100), so the stray file misled people and
  agents into reformatting. It was left over from the initial scaffold;
  the package.json key replaced it in Jan 2025. prettier --check src/
  still passes, so no formatting changes.
- Lower make dev's Node check from 21 to 20, matching engines and CI.
- Remove tests/setup.ts, which nothing references.
- Replace a machine-specific absolute path in docs/TOOLTIPS.md.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Oct 1, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: d4cf2592-a3d6-4c77-8ac7-c019b480b489

  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Autopilot is currently an internal CodeRabbit preview.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@ianmiell
ianmiell merged commit 7d3ff8a into main Oct 1, 2026
3 checks passed
@ianmiell
ianmiell deleted the docs/agents-md branch October 1, 2026 13:10
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.

2 participants