dd-trace-java / buildSrc
AGENTS.md739 starsChanged 6 days agoApache-2.0View on GitHub
Use gradle-best-practices before changing Gradle code here. If it is missing or incomplete, follow the skill setup before editing. For new conventions, follow the build logic placement advice. The Java 8 target in build.gradle.kts is needed by build-time instrumentation and Muzzle workers. A newer Gradle daemon or compiler JVM does not remove that requirement. JMH uses the consuming build's plugin classpath. Read the comments in its convention before changing that integration or adding JMH to implementation. The plugin tests use…
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 31,774 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository17 other files it gives its agents.
- AGENTS.mdAGENTS.md
- build-logic/AGENTS.mdAGENTS.md
- build-logic/CLAUDE.mdCLAUDE.md
- buildSrc/CLAUDE.mdCLAUDE.md
- .claude/CLAUDE.mdCLAUDE.md
- apm-integrationsSkill
- clarify-java-commentsSkill
- fix-continuation-leakageSkill
- java-lintSkill
- migrate-groovy-to-javaSkill
- migrate-junit-source-to-tabletestSkill
- perf-reviewSkill
- reproduce-ci-flakinessSkill
- resolve-muzzle-ciSkill
- review-groovy-migrationSkill
- techdebtSkill
- fix-continuation-leakageSkill
The file
We split this AGENTS.md into the rules it gives an agent
2 rules. About 0 are common, 0 are distinctive, and 2 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 3
Use gradle-best-practices before changing Gradle code here.
- Very specific: line 20
Keep the :test selector when filtering so the filter does not reach unrelated subprojects.
≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Working in buildSrc
Use gradle-best-practices before changing Gradle code here. If it is missing or incomplete,
follow the skill setup before editing.
For new conventions, follow the build logic placement advice.
The Java 8 target in build.gradle.kts is needed by build-time instrumentation and Muzzle
workers. A newer Gradle daemon or compiler JVM does not remove that requirement.
JMH uses the consuming build's plugin classpath. Read the comments in
its convention before changing
that integration or adding JMH to implementation.
Tests
The plugin tests use JUnit 5 and Kotlin. Reuse
GradleFixture for TestKit tests.
CLI tests need -PrunBuildSrcTests; see the test commands.
Keep the :test selector when filtering so the filter does not reach unrelated subprojects.
Changes to call-site-instrumentation-plugin or modifiable-config-agent also need their
own subproject tests. Run ./gradlew -p buildSrc spotlessCheck for formatting.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.