Skip to content

Commit ec920a5

Browse files
runningcodeclaude
authored andcommitted
docs(ai): Refresh AGENTS.md module list and fix coding.mdc command (#5517)
* docs(ai): Refresh AGENTS.md module list and fix coding.mdc command 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> * docs(ai): Note moving changelog entries to Unreleased on rebase 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> * docs(ai): Add changelog rebase note to AGENTS.md 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> --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent a0de8e0 commit ec920a5

3 files changed

Lines changed: 25 additions & 4 deletions

File tree

.cursor/rules/coding.mdc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@ sentry-java is the Java and Android SDK for Sentry. This repository contains the
2424
./gradlew check
2525

2626
# Run unit tests for a specific file
27-
./gradle ':<module>:testDebugUnitTest' --tests="*<file name>*" --info
27+
./gradlew ':<module>:testDebugUnitTest' --tests="*<file name>*" --info
2828
```
2929

3030
## Contributing Guidelines
3131

3232
1. Follow existing code style and language
33-
2. Do not modify the API files (e.g. sentry.api) manually, instead run `./gradlew apiDump` to regenerate them
33+
2. Do not modify the API files (e.g. sentry.api) manually, instead run `./gradlew apiDump` to regenerate them
3434
3. Write comprehensive tests
3535
4. New features should always be opt-in by default, extend `SentryOptions` or similar Option classes with getters and setters to enable/disable a new feature
3636
5. Consider backwards compatibility

.cursor/rules/pr.mdc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,8 @@ Entry format:
9393
- <Short description> ([#<PR_NUMBER>](https://github.com/getsentry/sentry-java/pull/<PR_NUMBER>))
9494
```
9595

96+
**When rebasing:** A rebase onto `main` can land your branch after a release was cut, where the `## Unreleased` heading your entry lived under has since been renamed to that version number. If that happens, move your new entry into an `## Unreleased` section at the top of `CHANGELOG.md` (create the section if it no longer exists) so it is not left under an already-released version.
97+
9698
Commit changelog separately:
9799

98100
```bash

AGENTS.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,14 @@ make systemTest
9292
6. **Format and regenerate**: Once done, format code and regenerate .api files: `./gradlew spotlessApply apiDump`
9393
7. **Propose commit**: As final step, git stage relevant files and propose (but not execute) a single git commit command
9494

95+
## Repository Skills
96+
97+
This repo ships task-specific skills (declared in `agents.toml`, sources under `.agents/skills`). Prefer them over performing the steps manually:
98+
- **`create-java-pr`**: Branch, format, `apiDump`, commit, push, open PR, and add the changelog entry (automates the PR workflow above)
99+
- **`test`**: Run unit or system tests for a module or a specific class
100+
- **`check-code-attribution`**: Verify third-party code attribution on the current branch (see Third-Party Code Attribution below)
101+
- **`btrace-perfetto`**: Capture and compare Perfetto traces for Android performance work
102+
95103
## Module Architecture
96104

97105
The repository is organized into multiple modules:
@@ -100,15 +108,22 @@ The repository is organized into multiple modules:
100108
- **`sentry`** - Core Java SDK implementation
101109
- **`sentry-android-core`** - Core Android SDK implementation
102110
- **`sentry-android`** - High-level Android SDK
111+
- **`sentry-android-ndk`** - Native (NDK) crash handling
103112

104113
### Integration Modules
105114
- **Spring Framework**: `sentry-spring*`, `sentry-spring-boot*`
106-
- **Logging**: `sentry-logback`, `sentry-log4j2`, `sentry-jul`
107-
- **Web**: `sentry-servlet*`, `sentry-okhttp`, `sentry-apache-http-client-5`
115+
- **Logging**: `sentry-logback`, `sentry-log4j2`, `sentry-jul`, `sentry-android-timber`
116+
- **Web**: `sentry-servlet*`, `sentry-okhttp`, `sentry-openfeign`, `sentry-apache-http-client-5`
108117
- **GraphQL**: `sentry-graphql*`, `sentry-apollo*`
109118
- **Android UI**: `sentry-android-fragment`, `sentry-android-navigation`, `sentry-compose`
119+
- **Session Replay**: `sentry-android-replay`
120+
- **Database**: `sentry-jdbc`, `sentry-android-sqlite`, `sentry-jcache`
110121
- **Reactive**: `sentry-reactor`, `sentry-ktor-client`
122+
- **Feature Flags**: `sentry-launchdarkly-android`, `sentry-launchdarkly-server`, `sentry-openfeature`
123+
- **Queues**: `sentry-kafka`
124+
- **Profiling**: `sentry-async-profiler` (JVM continuous profiling)
111125
- **Monitoring**: `sentry-opentelemetry*`, `sentry-quartz`
126+
- **Other**: `sentry-spotlight`, `sentry-kotlin-extensions`, `sentry-android-distribution`
112127

113128
### Utility Modules
114129
- **`sentry-test-support`** - Shared test utilities
@@ -171,6 +186,10 @@ gh pr view <branch-name> --json number -q '.number'
171186
gh pr view --json url -q '.url'
172187
```
173188

189+
### Changelog
190+
191+
User-facing changes get an entry under the `## Unreleased` section of `CHANGELOG.md`. When rebasing onto `main`, a release may have renamed the `## Unreleased` heading your entry was under to a version number — if so, move your entry back into an `## Unreleased` section at the top of the file (create it if it no longer exists). See `.cursor/rules/pr.mdc` for the full changelog and PR workflow.
192+
174193
## Useful Resources
175194

176195
- Main SDK documentation: https://develop.sentry.dev/sdk/overview/

0 commit comments

Comments
 (0)