Skip to content

Add AGENTS.md with guidance for AI coding agents - #280

Open
elharo wants to merge 2 commits into
masterfrom
fix/agreements-doc-agents
Open

Add AGENTS.md with guidance for AI coding agents#280
elharo wants to merge 2 commits into
masterfrom
fix/agreements-doc-agents

Conversation

@elharo

@elharo elharo commented Aug 2, 2026

Copy link
Copy Markdown
Contributor

Adds an AGENTS.md at the repository root so AI coding agents (opencode, Claude Code, and other agents) follow the project conventions.

The file instructs agents to:

  • Use test-first programming: write a failing test, confirm it fails, implement the change, and confirm it passes.
  • Run mvn spotless:apply before committing.
  • Verify mvn spotless:check, mvn checkstyle:check, mvn apache-rat:check, and mvn verify pass before opening or updating a pull request.
  • Use ASD-STE100 Simplified Technical English for documentation (README, site documentation, javadoc, code comments).

The commands were verified against this repository (spotless and checkstyle come from the maven-parent 49 POM). RAT requires a license header, so one was added and mvn apache-rat:check passes.

@olamy

olamy commented Aug 2, 2026

Copy link
Copy Markdown
Member

Adds an AGENTS.md at the repository root so AI coding agents (opencode, Claude Code, and other agents) follow the project conventions.

just saying this is not true for Claude code see anthropics/claude-code#6235

@elharo

elharo commented Aug 2, 2026

Copy link
Copy Markdown
Contributor Author

Looks like they're moving in that direction though.

@elharo
elharo requested a review from olamy August 2, 2026 12:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants