Skip to content

docs: move the guidance for coding agents to AGENTS.md - #180

Merged
ingvarch merged 1 commit into
mainfrom
docs/agents
Nov 4, 2026
Merged

ingvarch merged 1 commit into
mainfrom
docs/agents

Conversation

@ingvarch

@ingvarch ingvarch commented Nov 4, 2026

Copy link
Copy Markdown
Owner

What changes

The guidance for coding agents moves from CLAUDE.md to AGENTS.md, which other agents read too. CLAUDE.md is now one line, @AGENTS.md, which Claude Code reads as an import. CONTRIBUTING.md links the architecture rules there.

The rules were gone through one by one:

  • Rule 3 held two rules. Polling stays rule 3; the event stream is rule 4, "Events say when, reads say what". It names the second reader of event payloads, the failure note on the status line from A note on the status line when something fails in any namespace #153, next to :events. Rules 4-6 become 5-7.
  • Rule 3 also says a timer starts only through startTimer, and the rule on pure render says the time comes from m.now, with clockReaders listing who may read the clock. Tests already enforce both; the rules say it before a test fails.
  • The list of resources urga shows and the module path are dropped: they had gone stale, and internal/ui/views.go and go.mod say them.
  • "Do not copy damon" and the line from CONTRIBUTING.md about code under other licenses are one section.
  • "No mention of other tools by name" now says what it meant, from the commit that added the plain-words rule: comments and commit messages name no program urga resembles, as in "the way k9s does it".
  • New lines: tests that write a temporary file use tempDir(t), a PR body fills the template, commits carry no AI attribution, and only the maintainer pushes a release tag.

Checklist

  • The test for this change was written first and failed
  • make check is green
  • The title is a conventional commit: feat(ui): ..., fix(nomad): ...

CLAUDE.md imports AGENTS.md, so every agent reads the same rules. Rule 3 is split: polling stays rule 3, and the event stream gets rule 4, which names the failure note on the status line as the second reader of event payloads. The rule on pure render says where the time comes from, rule 3 names the one place a timer starts, and the process names the temp dir helper of the tests, the PR template and who releases.
@ingvarch ingvarch added this to the v0.17.0 milestone Nov 4, 2026
@ingvarch ingvarch added the documentation Improvements or additions to documentation label Nov 4, 2026
@ingvarch
ingvarch merged commit e0f3b5d into main Nov 4, 2026
5 checks passed
@ingvarch
ingvarch deleted the docs/agents branch November 4, 2026 09:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant