Commit

作者 davila78da17d671b6f无许可证32K 个星标收录于 2026年10月8日更新于 2026年10月8日仓库今天更新

Create commit messages following Sentry conventions. Use when committing code changes, writing commit messages, or formatting git history. Follows conventional commits with Sentry-specific issue references.

AI 生成的概览

按照 Sentry 的约定式提交规范格式化 Git 提交信息,包括问题引用。

功能
提供 Sentry 的提交信息规范:包含类型与可选范围的标题格式、允许的提交类型表、主题行规则、正文指南以及页脚问题引用模式。还给出简单修复、带范围的功能、重构、破坏性变更和回滚的示例。产出是格式化后的提交信息,而不是代码改动。
适用场景
适用于为 Sentry 项目撰写或审阅提交信息,或按这些规范整理 git 历史记录。适合需要正确类型前缀、祈使句主题以及 Fixes、Refs 等问题引用的提交。
运行要求
无需任何工具、软件包或凭据;仅为说明性内容,不附带脚本。

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

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 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-1234Fixes #1234Fixes SENTRY-1234Refs 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 crashin 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 originalSlack thread instead of creating a new message. This keeps relatednotifications grouped together.
Refs GH-1234

Refactor

ref: Extract common validation logic to shared module
Move duplicate validation code from three endpoints into a sharedvalidator 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 availableFixes 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

来源与署名

来源:davila7/claude-code-templates位于cli-tool/components/skills/sentry/commit提交8da17d6

许可证: 无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架