Skip to content

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

Merged
bwplotka merged 1 commit into
mainfrom
nicolastakashi/agents-md
Nov 4, 2026
Merged

bwplotka merged 1 commit into
mainfrom
nicolastakashi/agents-md

Conversation

@nicolastakashi

@nicolastakashi nicolastakashi commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

Adds an AGENTS.md so coding agents know how to verify a change, that testdata/ is generated by the Go harness, and that Go is the reference implementation. CLAUDE.md only imports it, the same pattern prometheus/prometheus uses.

The file only holds what an agent can't work out from the repo. It leaves out the overview and layout, which live in the README, and style rules, which CI enforces. That follows the Claude Code guidance and this study, which found that redundant context files raise cost without improving results.

PR titles in this repo mix area: and feat(area):. I wrote <area>: <summary>, happy to change it if we prefer one.

Signed-off-by: Nicolas Takashi <nicolas.takashi@dash0.com>
@nicolastakashi
nicolastakashi marked this pull request as ready for review November 4, 2026 11:52

@bwplotka bwplotka left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice, thx

@bwplotka
bwplotka merged commit a6e84d7 into main Nov 4, 2026
4 checks passed
@bwplotka
bwplotka deleted the nicolastakashi/agents-md branch November 4, 2026 12:06
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