---
name: commit
description: "Prepare or create commits using Sentry-style message conventions when the repository requests them; inspect staged scope and honor its protected branch workflow."
risk: critical
source: community
date_added: "2026-09-04"
---

# Sentry Commit Messages

Follow these conventions when creating commits for Sentry projects.

## When to Use
- The user asks to commit code, prepare a commit message, or save changes in git.
- You need Sentry-style commit formatting with conventional commit structure and issue references.
- The task requires enforcing branch safety before committing, especially avoiding direct commits on `main` or `master`.

## Prerequisites

Before committing, always check the current branch:

```bash
git branch --show-current
```

Read repository policy before creating a commit. If the default branch is PR-only,
create an authorized topic branch and use the repository's native maintainer flow,
even when an administrator could bypass server checks. AAS requires
`antigravity-maintainer-batch-release` and protected source PRs.

Inspect `git status --short`, `git diff --cached`, and the intended changed paths;
preserve unrelated staged/dirty work. Use an installed `create-branch` helper only
if available and appropriate, otherwise create the topic branch through the
repository workflow. Verify the actual branch before proceeding. A request for a
message alone does not authorize staging, committing or pushing.

## Format

```
<type>(<scope>): <subject>

<body>

<footer>
```

The header is required. Scope is optional. All lines must stay under 100 characters.

## Commit Types

| 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 |

## Subject Line Rules

- Use imperative, present tense: "Add feature" not "Added feature"
- Capitalize the first letter
- No period at the end
- Maximum 70 characters

## Body Guidelines

- Explain **what** and **why**, not how
- Use imperative mood and present tense
- Include motivation for the change
- Contrast with previous behavior when relevant

## Footer: Issue References

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 merged
- `Refs` links without closing

## AI-Generated Changes

Follow the repository's attribution policy and identify the actual contributor. The following is an example for Claude; do not attach it to work produced by a different agent or invent a person's contribution:

```
Co-Authored-By: Claude <noreply@anthropic.com>
```

Repository attribution and disclosure rules take precedence. 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.

## Examples

### Simple fix

```
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: Claude <noreply@anthropic.com>
```

### Feature with scope

```
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
```

### Refactor

```
ref: Extract common validation logic to shared module

Move duplicate validation code from three endpoints into a shared
validator class. No behavior change.
```

### Breaking 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 Format

```
revert: feat(api): Add new endpoint

This reverts commit abc123def456.

Reason: Caused performance regression in production.
```

## Principles

- Each commit should be a single, stable change
- Commits should be independently reviewable
- The repository should be in a working state after each commit

## References

- [Sentry Commit Messages](https://develop.sentry.dev/engineering-practices/commit-messages/)

## Limitations
- Use this skill only when the task clearly matches the scope described above.
- Direct-to-main instructions remain subordinate to server-side branch protection and required checks.
- Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
- Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.