Add `AGENTS.md`

[tay1orjones]

There are PRs being opened in the repo that are clearly the product of agentic workflows. It's common for these to miss the mark quality-wise. Simple things like coding conventions, docs, baseline react patterns, etc. are missed.

A good agents.md added to the repo root and in important subpackages could combat this some and provide better output.

Key attributes

• The shorter the better, these use tokens
• Subpackage agents.md are typically concatenated onto the root one
• Bad information poisons the context. It must be correct or clearly marked as optional/cursory/supportive in nature.

Content ideas

• Package structure (nested interdependency, elements into styles into react, etc.), this could be automated to ensure it's always up to date
• Common commands (build, test, format)
• Docs
• Guidance for opening and reviewing PRs
• Ensuring quality (expectations, how to validate)
• Code authoring guidance (style guide, code comments in tricky parts)
• ...

Resources

• https://agents.md
• https://www.aihero.dev/a-complete-guide-to-agents-md
• https://github.com/openai/codex/blob/main/AGENTS.md
• https://developers.openai.com/codex/guides/agents-md/
• https://github.com/openclaw/openclaw/blob/main/AGENTS.md
• https://github.com/mui/mui-x/blob/master/AGENTS.md
• https://github.com/primer/react/blob/main/.github/copilot-instructions.md

Follow-up tasks

• Expand outwards to ibm-products and other repos in the org

---

Superscedes #21269

[github-actions]

Thank you for submitting a feature request. Your proposal is open and will soon be triaged by the Carbon team.

If your proposal is accepted and the Carbon team has bandwidth they will take on the issue, or else request you or other volunteers from the community to work on this issue.