Skip to content

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

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.

  • AGENTS.md is read by most coding agents. CLAUDE.md is one line, @AGENTS.md, so Claude Code reads the same file.
  • It keeps only how we want agents to work: the checks to run before finishing and our code standards.
  • A Slack Plugin section 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 2722e95 into main Oct 26, 2026
3 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