Skip to content

docs: Add agent rules for API, options, and PR workflows#5133

Merged
adinauer merged 2 commits intomainfrom
docs/agent-rules
Mar 2, 2026
Merged

docs: Add agent rules for API, options, and PR workflows#5133
adinauer merged 2 commits intomainfrom
docs/agent-rules

Conversation

@adinauer
Copy link
Member

@adinauer adinauer commented Mar 2, 2026

📜 Description

Add new cursor rules to guide AI coding agents when working on specific areas of the SDK:

  • api.mdc — Public API surface, binary compatibility, key classes to modify when adding new API
  • options.mdc — Adding/modifying SDK options across all configuration layers (SentryOptions, ExternalOptions, ManifestMetadataReader, Spring Boot)
  • pr.mdc — PR creation workflow, stacked PRs, stack comments, merging and syncing stacks

Updates overview_dev.mdc to reference the new rules with context clues for when to fetch them.

💡 Motivation and Context

These rules capture institutional knowledge that agents need when working on common SDK tasks. Without them, agents miss steps (e.g. forgetting to update ExternalOptions when adding a new option) or don't follow established patterns (e.g. stacked PR naming conventions).

💚 How did you test it?

Reviewed the generated rule files for accuracy against the existing codebase patterns. The rules are documentation only — no runtime behavior changes.

📝 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

Add more domain-specific rules as patterns are identified (e.g. scopes, offline/caching, metrics).

#skip-changelog

Add cursor rules for public API surface (api.mdc), SDK options
(options.mdc), and PR workflow including stacked PRs (pr.mdc).
Update overview_dev.mdc to reference the new rules. Add Claude Code
skill for creating pull requests.

Co-Authored-By: Claude <noreply@anthropic.com>
@github-actions
Copy link
Contributor

github-actions bot commented Mar 2, 2026

Semver Impact of This PR

🟢 Patch (bug fixes)

📋 Changelog Preview

This is how your changes will appear in the changelog.
Entries from this PR are highlighted with a left border (blockquote style).


This PR will not appear in the changelog.


🤖 This preview updates automatically when you update the PR.

@adinauer adinauer marked this pull request as ready for review March 2, 2026 09:42
Co-Authored-By: Claude <noreply@anthropic.com>
@adinauer adinauer merged commit fc52bb8 into main Mar 2, 2026
65 checks passed
@adinauer adinauer deleted the docs/agent-rules branch March 2, 2026 11:27
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