mcpField
C
commit

commit

github.com/getsentryDevelopment1.1k4.8k installsUpdated 5d ago
Repository

About commit

A commit-writing skill for developers that defines branch safeguards, message format, and privacy rules. It also covers when to split changes and how to add issue and breaking-change footers.

Key features

  1. 01Branch safeguards before committing
  2. 02Conventional message types and formatting
  3. 03Guidance for coherent change boundaries
  4. 04Privacy rules for commit content
  5. 05Issue and breaking-change footers

Use cases

  1. 01Preparing a commit on a feature branch
  2. 02Choosing a message type for a refactor
  3. 03Recording an issue reference in a commit

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/getsentry/skills --skill commit

After installing, type/commitin Claude Code to confirm it loaded.

Details

From the project README

Sentry Commit Messages

Before Committing

git branch --show-current

If the branch is main or master, create a feature branch unless the user explicitly requested a direct commit. Re-check the branch and stop if it is still main or master.

Commit one coherent, independently reviewable change at a time.

Message Rules

Use:

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

<optional body>

<optional footer>
  • Scope is optional. Add ! before : for a breaking change.
  • Write the subject in imperative, present tense; capitalize it, omit the trailing period, and keep it at 70 characters or fewer.
  • Keep every line under 100 characters.
  • Use the body only when useful. Explain what changed and why, including previous behavior or motivation when it helps.
  • Never include customer or organization names, user emails, support ticket contents, secrets, or PII. Describe the technical symptom instead.

Allowed types: feat, fix, ref, perf, docs, test, build, ci, chore, style, meta, license, and revert.

Use ref for refactoring without behavior changes, style for formatting without logic changes, and meta for repository metadata.

Footers

  • Fixes <issue> closes an issue when merged.
  • Refs <issue> links an issue without closing it.
  • For breaking changes, add BREAKING CHANGE: <impact>.

Creating the Commit

Use separate -m arguments for paragraphs and footers. Never put literal \n sequences in a commit message or open an interactive editor.

git commit -m "fix(api): Handle null response in user endpoint" \
  -m "Return 404 when the user API finds a deleted account." \
  -m "Fixes SENTRY-5678"

Comments

Markdown supported