plugins/sentry-skills/skills/commit/SKILL.md
ALWAYS use this skill when committing code changes — never commit directly without it. Creates commits following Sentry conventions with proper conventional commit format and issue references. Trigger on any commit, git commit, save changes, or commit message task.
npx skillsauth add getsentry/skills commitInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
Follow these conventions when creating commits for Sentry projects.
Before committing, always check the current branch:
git branch --show-current
If you're on main or master, you MUST create a feature branch first — unless the user explicitly asked to commit to main. Do not ask the user whether to create a branch; just proceed with branch creation. The create-branch skill should derive and create a suitable branch name automatically.
Use the create-branch skill to create the branch. After create-branch completes, verify the current branch has changed before proceeding:
git branch --show-current
If still on main or master, stop — do not commit.
<type>(<scope>): <subject>
<body>
<footer>
The header is required. Scope is optional. All lines must stay under 100 characters.
| Type | Purpose |
|------|---------|
| feat | New feature |
| fix | Bug fix |
| ref | Refactoring (no behavior change) |
| perf | Performance improvement |
| docs | Documentation only |
| test | Test additions or corrections |
| build | Build system or dependencies |
| ci | CI configuration |
| chore | Maintenance tasks |
| style | Code formatting (no logic change) |
| meta | Repository metadata |
| license | License changes |
\n sequencesFixes SENTRY-1234).When creating commits from the CLI, do not embed escaped newlines like \n inside -m strings. That produces literal backslash characters in the final commit message.
Prefer one of these patterns:
git commit -m "type(scope): Subject" \
-m "First paragraph with real line wrapping.
Second paragraph.
Fixes GH-1234
Co-Authored-By: (the agent's name and attribution byline)"
git commit
Use the editor flow when the message needs careful formatting.
Reference issues in the footer using these patterns:
Fixes GH-1234
Fixes #1234
Fixes SENTRY-1234
Refs LINEAR-ABC-123
Fixes closes the issue when mergedRefs links without closingWhen changes were primarily generated by a coding agent, include the Co-Authored-By attribution in the commit footer. Agents should use their own identity:
Co-Authored-By: (the agent's name and attribution byline)
Example: Co-Authored-By: Claude Sonnet 4 <[email protected]>
This is the only indicator of AI involvement that should appear in commits. Do not add phrases like "Generated by AI", "Written with Claude", or similar markers in the subject, body, or anywhere else in the commit message.
fix(api): Handle null response in user endpoint
The user API could return null for deleted accounts, causing a crash
in the dashboard. Add null check before accessing user properties.
Fixes SENTRY-5678
Co-Authored-By: (the agent's name and attribution byline)
feat(alerts): Add Slack thread replies for alert updates
When an alert is updated or resolved, post a reply to the original
Slack thread instead of creating a new message. This keeps related
notifications grouped together.
Refs GH-1234
ref: Extract common validation logic to shared module
Move duplicate validation code from three endpoints into a shared
validator class. No behavior change.
feat(api)!: Remove deprecated v1 endpoints
Remove all v1 API endpoints that were deprecated in version 23.1.
Clients should migrate to v2 endpoints.
BREAKING CHANGE: v1 endpoints no longer available
Fixes SENTRY-9999
revert: feat(api): Add new endpoint
This reverts commit abc123def456.
Reason: Caused performance regression in production.
development
Document and type a Sentry API endpoint. Write or fix @extend_schema decorators, specify response TypedDicts, type request parameters, correct type drift between the declared schema and the runtime response, and validate the generated spec. Use when asked to "document an endpoint", "add OpenAPI docs", "add/fix @extend_schema", "type an endpoint response", "fix the response type", "fix type drift", "reuse a response type", "split an overloaded endpoint", "specify the response schema", "add a TypedDict response", "migrate a legacy api-docs path", "fix a parameter type", or "make an endpoint public" / "promote an endpoint" (promotion is one section here).
documentation
Create, refresh, and rewrite PR titles and descriptions following Sentry conventions. Use when opening a PR, writing or updating a PR title/body/description, refreshing an existing PR after material changes, or preparing branch changes for review.
tools
Analyze a repository to generate recommended Claude Code settings.json permissions. Use when setting up a new project, auditing existing settings, or determining which read-only bash commands to allow. Detects tech stack, build tools, and monorepo structure.
development
Triage new issues in the Sentry `javascript` project by archiving non-actionable noise. Use when asked to "triage issues", "triage the javascript project", "archive non-actionable issues", "triage new frontend issues", or "clean up the sentry/javascript queue". Operates only on the sentry/javascript project, only archives (never resolves), and always archives with `untilEscalating`.