Skip to content

Document the conventions an agent needs to work in this repository - #1579

Merged
papegaaij merged 1 commit into
masterfrom
agents-md
Sep 8, 2026
Merged

Document the conventions an agent needs to work in this repository#1579
papegaaij merged 1 commit into
masterfrom
agents-md

Conversation

@papegaaij

Copy link
Copy Markdown
Contributor

Nothing in the repository said how a change is made here, so a coding agent had to infer it, and the parts that matter most are the ones least visible from the source: that tests for a module usually live in a different module, that pom section and dependency order is enforced before anything compiles, that a class not named *Test is never run, and that pushing is not the agent's call.

AGENTS.md records those, along with the branch and cherry-pick order, the commit message shape, what an API change on master owes its users, and the comment, Javadoc and language rules. It deliberately does not repeat what is already readable from pom.xml, the CI workflow or SECURITY.md, because a second copy of a version number or a policy only goes stale and then misleads. CLAUDE.md just includes it, so Claude Code and any agent reading AGENTS.md see the same file.

This changes nothing about the build. A contributor who ignores both files is in exactly the position they were in before.

Nothing in the repository said how a change is made here, so a coding agent
had to infer it, and the parts that matter most are the ones least visible
from the source: that tests for a module usually live in a different module,
that pom section and dependency order is enforced before anything compiles,
that a class not named *Test is never run, and that pushing is not the agent's
call.

AGENTS.md records those, along with the branch and cherry-pick order, the
commit message shape, what an API change on master owes its users, and the
comment, Javadoc and language rules. It deliberately does not repeat what is
already readable from pom.xml, the CI workflow or SECURITY.md, because a
second copy of a version number or a policy only goes stale and then misleads.
CLAUDE.md just includes it, so Claude Code and any agent reading AGENTS.md see
the same file.

This changes nothing about the build. A contributor who ignores both files is
in exactly the position they were in before.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 61.85%. Comparing base (ca5252b) to head (ee6f1d5).
⚠️ Report is 3 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##             master    #1579   +/-   ##
=========================================
  Coverage     61.85%   61.85%           
+ Complexity    11181    11180    -1     
=========================================
  Files          1245     1245           
  Lines         48220    48220           
  Branches       6759     6759           
=========================================
  Hits          29825    29825           
  Misses        15694    15694           
  Partials       2701     2701           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@reiern70 reiern70 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. We lacck the SECURITY.md

@papegaaij

Copy link
Copy Markdown
Contributor Author

@reiern70 Actually, we do have a SECURITY.md for some time now. It should help a bit keeping the bad security reports away.

@papegaaij
papegaaij merged commit 47ed3f2 into master Sep 8, 2026
3 checks passed
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