AgentSkillsCN

sentry-commit-messages

遵循 Sentry 的常规提交规范,结合传统提交格式与问题引用,为代码提交撰写 Commit 消息。适用于提交代码变更、撰写 Commit 消息,或以 Fixes/Refs 格式美化 Git 历史记录时使用。

SKILL.md
--- frontmatter
name: sentry-commit-messages
description: Create commit messages following Sentry conventions with conventional commits and issue references. Use when committing code changes, writing commit messages, or formatting git history with Fixes/Refs patterns.

Sentry Commit Messages

Format

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

<body>

<footer>

Requirements:

  • Header is required; scope is optional
  • All lines must stay under 100 characters
  • Subject line max 70 characters

Commit Types

TypePurpose
featNew feature
fixBug fix
refRefactoring (no behavior change)
perfPerformance improvement
docsDocumentation only
testTest additions or corrections
buildBuild system or dependencies
ciCI configuration
choreMaintenance tasks
styleCode formatting (no logic change)
metaRepository metadata
licenseLicense changes

Subject Line Checklist

When writing the subject line:

  • 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
  • Wrap at 100 characters

Footer: Issue References

Reference issues using these patterns:

code
Fixes GH-1234          # GitHub issue
Fixes #1234            # Shorthand GitHub
Fixes SENTRY-1234      # Sentry issue
Refs LINEAR-ABC-123    # Linear issue (no auto-close)
  • Fixes closes the issue when merged
  • Refs links without closing

Breaking Changes

For breaking changes, add ! after type/scope and include a footer:

code
feat(api)!: Remove deprecated v1 endpoints

BREAKING CHANGE: v1 endpoints no longer available

Revert Format

code
revert: feat(api): Add new endpoint

This reverts commit abc123def456.

Reason: Caused performance regression in production.

Examples

See examples.md for detailed commit examples across different scenarios.