docs: Add agent rules for API, options, and PR workflows#5133
Merged
Conversation
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>
Contributor
Semver Impact of This PR🟢 Patch (bug fixes) 📋 Changelog PreviewThis is how your changes will appear in the changelog. This PR will not appear in the changelog. 🤖 This preview updates automatically when you update the PR. |
Co-Authored-By: Claude <noreply@anthropic.com>
romtsn
approved these changes
Mar 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📜 Description
Add new cursor rules to guide AI coding agents when working on specific areas of the SDK:
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
sendDefaultPIIis enabled.🔮 Next steps
Add more domain-specific rules as patterns are identified (e.g. scopes, offline/caching, metrics).
#skip-changelog