Skip to content

docs(ai): Refresh AGENTS.md module list and fix coding.mdc command#5517

Open
runningcode wants to merge 3 commits into
mainfrom
no/refresh-agents-md
Open

docs(ai): Refresh AGENTS.md module list and fix coding.mdc command#5517
runningcode wants to merge 3 commits into
mainfrom
no/refresh-agents-md

Conversation

@runningcode
Copy link
Copy Markdown
Contributor

📜 Description

Brings the agent-instruction docs back in line with the repo:

  • AGENTS.md Module Architecture — the list had drifted and omitted whole product areas that now exist as modules and already have dedicated .cursor/rules. Added Session Replay (sentry-android-replay), Feature Flags (sentry-launchdarkly-*, sentry-openfeature), Queues (sentry-kafka), and JVM continuous profiling (sentry-async-profiler), plus the other previously-unlisted modules (NDK, SQLite, Timber, JDBC, JCache, OpenFeign, Spotlight, etc.), grouped under clear categories.
  • AGENTS.md Repository Skills — added a short pointer to the repo's committed skills (create-java-pr, test, check-code-attribution, btrace-perfetto) so agents prefer them over the manual workflow steps.
  • .cursor/rules/coding.mdc — fixed a typo where the per-file test command used ./gradle instead of ./gradlew, and removed a stray double space in ./gradlew apiDump.

💡 Motivation and Context

AGENTS.md is the required-reading entrypoint for AI coding agents in this repo, but its module list predated several modules/product areas, and the coding.mdc test command was broken. Both lead agents astray.

💚 How did you test it?

Docs-only change. Verified the module list against settings.gradle.kts and the corrected command against the Makefile / Gradle task names.

📝 Checklist

  • I added GH Issue ID & Linear ID
  • I added tests to verify the changes.
  • No new PII added or SDK only sends newly added PII if sendDefaultPII is enabled.
  • I updated the docs if needed.
  • I updated the wizard if needed.
  • Review from the native team if needed.
  • No breaking change or entry added to the changelog.
  • No breaking change for hybrid SDKs or communicated to hybrid SDKs.

🔮 Next steps

None.

#skip-changelog

The Module Architecture section omitted several product areas that now
exist as modules and already have dedicated .cursor/rules: Session
Replay, Feature Flags, Queues (Kafka), and JVM continuous profiling. Add
them alongside the other previously-unlisted modules, and add a pointer
to the repository's task-specific skills.

Also fix a typo in coding.mdc where the per-file test command used
./gradle instead of ./gradlew.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@sentry
Copy link
Copy Markdown

sentry Bot commented Jun 8, 2026

📲 Install Builds

Android

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

⚙️ sentry-android Build Distribution Settings

Copy link
Copy Markdown
Member

@0xadam-brown 0xadam-brown left a comment

Choose a reason for hiding this comment

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

🙏

@runningcode runningcode marked this pull request as ready for review June 8, 2026 14:53
runningcode and others added 2 commits June 8, 2026 17:43
A rebase onto main can land a branch after a release was cut, leaving a
new changelog entry under an already-released version heading. Document
that the entry should be moved back into an Unreleased section at the
top of CHANGELOG.md.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
AGENTS.md is the always-loaded entrypoint, so the rebase reminder reaches
agents more reliably here than in an on-demand .cursor rule. Keep the
detailed workflow in pr.mdc and point to it from here.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.

2 participants