Repository navigation
docs: add AGENTS.md for coding agents - #319
Merged
Merged
Conversation
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>
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Advanced Run ID:
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. Comment |
This was referenced Oct 1, 2026
gusfcarvalho
approved these changes
Oct 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
AGENTS.md, guidance for coding agents (Claude Code, Codex, Copilot, Cursor), plus a one-lineCLAUDE.md(@AGENTS.md) so Claude Code loads it.It covers what isn't obvious from the code:
make reviewable, a single spec withnpx vitest run,VITE_API_URLfor local-dev);camelcaseStopPathspaths work),decamelizeKeysproducing kebab-case,useDataApiunwrapping{data}, binary responses;<script setup lang="ts">, explicit imports, hand-written types, vendoredsrc/volt,LabelList.vuehiding_labels;computedbefore awatchthat reads it.Other changes
.prettierrc.json. Prettier never read it. When both exist, theprettierkey inpackage.jsonwins (npx prettier --find-config-path src/main.tsreportspackage.json), and that is the style the code follows: semicolons and trailing commas. The two configs disagreed (.prettierrc.jsonsaid 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); thepackage.jsonkey replaced it in Jan 2025.prettier --check src/still passes without it, so nothing is reformatted. If a standalone config file is preferred, thepackage.jsonsettings can be moved into.prettierrc.jsoninstead; what matters is having only one.make dev's Node check from 21 to 20, matchingenginesand CI.tests/setup.ts, which nothing references (vitest usesvitest.setup.ts).docs/TOOLTIPS.md.make reviewablepasses (1116 tests). A fresh agent given onlyCLAUDE.mdplanned 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