Skip to content

docs: Add AGENTS.md conventions for coding agents - #235

Open
mike-scott wants to merge 2 commits into
mainfrom
ai-agent-setup
Open

docs: Add AGENTS.md conventions for coding agents#235
mike-scott wants to merge 2 commits into
mainfrom
ai-agent-setup

Conversation

@mike-scott

Copy link
Copy Markdown
Contributor

Give AI coding agents standing instructions for working in this repository: grounding requirements, analysis and verification expectations, answer format and voice, scope limits, and commit conventions. CLAUDE.md points Claude Code at AGENTS.md so both tools share one source.

@doanac doanac 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.

I have no idea what best practices are for this file. Comparing to meta-qcom I notice that:

  • this is much more verbose - perhaps that's a good thing?
  • doesn't include procedures for common tasks like building

@mike-scott

Copy link
Copy Markdown
Contributor Author

I have no idea what best practices are for this file. Comparing to meta-qcom I notice that:

  • this is much more verbose - perhaps that's a good thing?
  • doesn't include procedures for common tasks like building

Yep, this sets up the "persona" and basic backgrounder files. We can also add a first "How can I help you get started?" type response back to the user with a path of things it should know how to help with:

  • Building
  • Testing (especially the E2E testing setup)
  • Contributing
  • Etc

mike-scott and others added 2 commits August 26, 2026 14:35
Give AI coding agents standing instructions for working in this
repository: grounding requirements, analysis and verification
expectations, answer format and voice, and scope limits. CLAUDE.md
points Claude Code at AGENTS.md so both tools share one source.

Signed-off-by: Michael Scott <mike@foundries.io>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Collect the writing conventions where human contributors can find
them: the Markdown doc rules established in the PR#238 review round,
plus the code comment, commit message, and trailer conventions that
AGENTS.md directs coding agents to follow.

Signed-off-by: Michael Scott <mike@foundries.io>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@mike-scott

Copy link
Copy Markdown
Contributor Author

Added a STYLE.md based on findings in #238

@mike-scott

Copy link
Copy Markdown
Contributor Author

Oof. I realize, I should have used: https://github.com/foundriesio/fio-style/blob/main/style-guide.md

@kprosise

Copy link
Copy Markdown
Contributor

Oof. I realize, I should have used: https://github.com/foundriesio/fio-style/blob/main/style-guide.md

No worries. In the near future, the style guide will be downloaded with the rest of fio-style—along with a set of skills and linter rules—for all our repos.

@mike-scott

Copy link
Copy Markdown
Contributor Author

@kprosise Should we wait for the work you're doing on fiostyle?

@kprosise

Copy link
Copy Markdown
Contributor

@kprosise Should we wait for the work you're doing on fiostyle?

Up to you. On the one hand I don't have Agent specific skills set, will need to setup everything to make it easier to use and semi-automated, and this will take a little bit…on the other hand, you could potentially point the agent to the style guide/merge this PR now while I work on finishing fio-style stuff, and then we can change it up later.

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.

3 participants