Skip to content

docs(agents): Remove duplicated build commands and rules - #5971

Open
runningcode wants to merge 2 commits into
mainfrom
no/agent-docs-redundancy
Open

docs(agents): Remove duplicated build commands and rules#5971
runningcode wants to merge 2 commits into
mainfrom
no/agent-docs-redundancy

Conversation

@runningcode

@runningcode runningcode commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

📜 Description

Removes duplicated instructions from the agent docs. Every removed line is still stated somewhere that is loaded when it applies so nothing is lost. I also told claude to run subagents to test and ensure that instructions were followed and the correct files were loaded.

💡 Motivation and Context

Removing duplicated instructions saves context, money and time!

💚 How did you test it?

Ran six agents against the first commit, each given a realistic task and no hint that the docs had changed, then checked their actual tool calls rather than asking them what they'd read:

Scenario Rules loaded Skill Result
Run ScopesTest in sentry read test :sentry:test --tests="*ScopesTest*"
Run sentry-android-fragment tests invoked test testReleaseUnitTest
Add an enableFooBar option options, api cited test, create-java-pr all 5 config layers ✓
Add Sentry.setFoo api, scopes cited test, create-java-pr 13 files incl. HubAdapter breakage ✓
Add a sentry-foo module new_module, e2e_tests cited all three
Prepare a PR read create-java-pr all 6 steps ✓

All six read AGENTS.md first and loaded the correct domain rule off the table, with no misroutes. The new-module scenario reproduced all four points deleted from new_module.mdc's "Important Notes", which was the riskiest deletion. Two agents quoted the new text back verbatim ("AGENTS.md says not to compose Gradle test invocations by hand"; "AGENTS.md requires new features to be opt-in").

📝 Checklist

  • No new PII added or SDK only sends newly added PII if sendDefaultPII is enabled.
  • No breaking change or entry added to the changelog.
  • No breaking change for hybrid SDKs or communicated to hybrid SDKs.

🔮 Next steps

#skip-changelog

AGENTS.md is force-read at the start of every session, so anything stated
there costs context on every task. Several rules had accumulated multiple
copies of themselves within that one file.

`spotlessApply`/`apiDump` was stated five times in AGENTS.md; it is now
stated once as a command and once as a workflow step, with the underlying
facts (Spotless enforces formatting, `.api` files are generated) kept where
they belong. The Testing command block is dropped in favour of the `test`
skill, which already resolves the per-module task and the unit-vs-system
split and does not drift. The Repository Skills bullet list restated skill
descriptions that the harness already injects, so it is now a pointer.

In the rules, `new_module.mdc`'s "Important Notes" was a verbatim
restatement of the AGENTS.md contributing guidelines, and `api.mdc` repeated
the opt-in-by-default rule in passing; both now defer to their canonical
homes.

No guidance is lost — every removed line is still stated somewhere that is
loaded when it applies.
@sentry

sentry Bot commented Aug 14, 2026

Copy link
Copy Markdown

📲 Install Builds

Android

🔗 App Name App ID Version Configuration
SDK Size io.sentry.tests.size 8.53.0 (1) release

⚙️ sentry-android Build Distribution Settings

Validating the previous commit with agents surfaced two gaps.

`new_module.mdc` had drifted from the repo. Its README badge snippet still
used the retired maven-badges.herokuapp.com format, while every current row
in README.md uses shields.io with a central.sonatype.com link. It also never
mentioned four steps that every existing integration module performs: the
`SENTRY_*_SDK_NAME` constant in `Config.kt` consumed by buildConfig and the
jar manifest, the `libs.versions.toml` entry paired with a `compileOnly`
dependency, self-registration via `SentryIntegrationPackageStorage.addPackage`
and `addIntegrationToSdkVersion`, and the integrations dropdown in the issue
template. It now also points at `sentry-kafka` and `sentry-android-timber` as
build-script templates, and records that `sentry-bom` and the root build file
need no change because they iterate over subprojects.

The `test` skill only ever ran a single module, so folding the AGENTS.md
testing block into it dropped the only reference to running the whole system
test suite. Step 3b now covers `make systemTest` and `make systemTestInteractive`.
@runningcode
runningcode marked this pull request as ready for review August 14, 2026 13:46
@runningcode runningcode added the ship-it PR is ready to merge from a reviewer perspective label Aug 14, 2026
@linear-code

linear-code Bot commented Aug 14, 2026

Copy link
Copy Markdown

JAVA-689

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ship-it PR is ready to merge from a reviewer perspective

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant