Opening a Pull Request
This playbook guides contributors through creating a well-structured pull request for an SDK repository. It covers branch naming, commit formatting, local verification, draft PR workflow, and review assignment. By following these steps, PRs will have proper documentation, pass CI checks, and be ready for efficient review.
Related resources:
- Code Submission Standards — commit format, branch naming, and PR requirements
- Sentry Skills — automation tools for commits and PRs
- Repository Documentation Standards — documentation requirements
You MUST use the naming convention <username>/<type>/<short-description> (Branch naming).
Examples: theo/feat/add-user-auth, alice/fix/rate-limit-parsing.
If there isn't one, create it first — even for internal work. Non-trivial changes REQUIRE an issue before a PR (PR description quality).
You MUST use conventional format. If AI-assisted, you MUST add Co-Authored-By in the commit footer (AI attribution).
You SHOULD use the sentry-skills:commit skill to create properly formatted commits.
Tests MUST pass, linter MUST pass, and the SDK MUST build cleanly before opening a PR.
You MUST open PRs as drafts (PR draft mode).
You SHOULD use the sentry-skills:create-pr skill to create the PR with proper formatting.
You MUST include: what changed, why, linked issue, and context for reviewers. No boilerplate, no test plan sections (PR description quality).
You MUST add a changelog entry (Changelog entry) and open or link a docs PR (Documentation-with-code).
When green, mark the PR as ready for review.
If the PR touches public API, dependencies, or security-sensitive areas, you MUST assign an @sdk-seniors reviewer (Required reviewers).
- Branch naming — branch naming convention format
- Commit message format — conventional commit structure
- AI attribution — Co-Authored-By footer requirement
- PR draft mode — draft PR workflow
- PR description quality — description content requirements
- Changelog entry — user-facing change documentation
- One logical change per PR — focused PR scope
- Documentation-with-code — docs PR requirements
- Required reviewers — @sdk-seniors review triggers
- Test requirements by change type — test coverage requirements
| Version | Date | Summary |
|---|---|---|
1.0.0 | 2026-02-21 | Initial playbook — standardized pull request creation workflow from branch to review |
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").