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 從公開儲存庫中收錄這些內容。

檢舉或申請下架