Skip to content

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

Merged
mwbrooks merged 1 commit into
mainfrom
mwbrooks-agents-md
Oct 26, 2026
Merged

mwbrooks merged 1 commit into
mainfrom
mwbrooks-agents-md

Conversation

@mwbrooks

Copy link
Copy Markdown
Member

Summary

This pull request gives developers who build this sample with a coding agent a short AGENTS.md with the guidance an agent can't work out from the code, and points every agent to the README's install steps for the Slack plugin.

  • The guidance in each .claude/CLAUDE.md moves to AGENTS.md, which most coding agents read. Each CLAUDE.md is now one line, @AGENTS.md, so Claude Code reads the same file.
  • Each AGENTS.md keeps only how we want agents to work: run lint and tests before finishing, our code standards, and at the root, keeping the implementations in parity. Commands, layout, and architecture are left for the agent to read from the project, so they can't go stale here.
  • Each project folder has its own AGENTS.md, so the guidance still works for a developer who only has that folder.
  • A Slack Plugin section in each AGENTS.md links to the README's "Claude Code, Codex, Cursor, and Other Coding Agents" section instead of repeating the install commands.
  • Same shape as docs: add AGENTS.md for coding agents bolt-js-starter-agent#156.

Testing

@mwbrooks mwbrooks added the documentation Improvements or additions to documentation label Oct 23, 2026
@mwbrooks mwbrooks self-assigned this Oct 23, 2026
@mwbrooks
mwbrooks marked this pull request as ready for review October 23, 2026 21:23
@mwbrooks
mwbrooks requested a review from a team as a code owner October 23, 2026 21:23
@mwbrooks
mwbrooks merged commit 58aa95d into main Oct 26, 2026
8 checks passed
@mwbrooks
mwbrooks deleted the mwbrooks-agents-md branch October 26, 2026 16:49
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.

2 participants