Sentry提交消息规范指南：Git Commit格式、类型与最佳实践

commit by davila7/claude-code-templates

258 周安装量

23,400 GitHub Stars

GitHub

安装命令

npx skills add https://github.com/davila7/claude-code-templates --skill commit

开发代码规范开发运维

🇨🇳中文介绍

Sentry 提交消息规范

为 Sentry 项目创建提交时，请遵循以下约定。

格式

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

<body>

<footer>

提交头是必需的。作用域是可选的。所有行必须保持在 100 个字符以内。

提交类型

类型	用途
`feat`	新功能
`fix`	错误修复
`ref`	重构（无行为变更）
`perf`	性能改进

广告位招租

在这里展示您的产品或服务

触达数万 AI 开发者，精准高效

联系我们

页脚：问题引用

使用以下模式在页脚中引用问题：

Fixes GH-1234
Fixes #1234
Fixes SENTRY-1234
Refs LINEAR-ABC-123

Fixes 在合并时关闭问题
Refs 仅链接而不关闭问题

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

带作用域的功能

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.

每次提交应是一个单一、稳定的变更
提交应可独立审查
每次提交后，仓库应处于可工作状态

🇺🇸English

Sentry Commit Messages

Follow these conventions when creating commits for Sentry projects.

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

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

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

Weekly Installs

235

Repository

davila7/claude-…emplates

GitHub Stars

22.6K

First Seen

Jan 21, 2026

Security Audits

Gen Agent Trust HubPass SocketPass SnykPass

Installed on

opencode186

claude-code183

gemini-cli176

codex156

cursor154

github-copilot141

React 组合模式指南：Vercel 组件架构最佳实践，提升代码可维护性

106,200 周安装