关于 commit
为 Sentry 项目提供提交规范指导,适用于准备提交说明或提交代码。它规定提交格式、问题引用、分支检查,以及保护已暂存和无关改动的做法。
主要功能
- 01Sentry 提交格式
- 02约定式提交类型
- 03问题引用规范
- 04分支与仓库策略检查
- 05保留无关改动
适用场景
- 01编写 Sentry 风格的提交说明
- 02提交前检查分支安全
- 03在提交中引用问题
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ sickn33/ agentic-awesome-skills --skill commit安装后在 Claude Code 中输入/commit确认已加载。
详细介绍
Sentry 提交消息
为 Sentry 项目创建提交时,请遵循这些约定。
适用场景
- 用户要求提交代码、准备提交消息或在 git 中保存更改。
- 你需要遵循 Sentry 风格的提交格式,包括约定式提交结构和问题引用。
- 任务要求在提交前确保分支安全,尤其要避免直接在
main或master上提交。
前提条件
提交前,务必检查当前分支:
git branch --show-current
创建提交前,请先阅读仓库策略。如果默认分支仅允许通过 PR 修改,
请创建获准的主题分支,并使用仓库原生的维护者流程,
即使管理员可以绕过服务器检查也不例外。AAS 要求
antigravity-maintainer-batch-release 和受保护的源 PR。
检查 git status --short、git diff --cached 和计划修改的路径;
保留无关的暂存和工作区更改。仅当已安装 create-branch 助手且适用时才使用,
否则请通过仓库工作流创建主题分支。继续前请确认实际分支。仅请求提交消息
并不代表授权暂存、提交或推送。
格式
<type>(<scope>): <subject>
<body>
<footer>
标题为必填项。范围为可选项。每行必须少于 100 个字符。
提交类型
| 类型 | 用途 |
|---|---|
feat | 新功能 |
fix | 修复 bug |
ref | 重构(不改变行为) |
perf | 性能改进 |
docs | 仅修改文档 |
test | 添加或修正测试 |
build | 构建系统或依赖项 |
ci | CI 配置 |
chore | 维护任务 |
style | 代码格式调整(不改变逻辑) |
meta | 仓库元数据 |
license | 许可证更改 |
标题行规则
- 使用祈使语气和现在时:“Add feature”,而不是 “Added feature”
- 首字母大写
- 末尾不加句号
- 最多 70 个字符
正文指南
- 说明是什么以及为什么,而非如何实现
- 使用祈使语气和现在时
- 说明更改的动机
- 适用时,对比之前的行为
页脚:问题引用
在页脚中使用以下格式引用问题:
Fixes GH-1234
Fixes #1234
Fixes SENTRY-1234
Refs LINEAR-ABC-123
- 合并后,
Fixes会关闭问题 Refs仅建立关联,不会关闭问题
AI 生成的更改
遵循仓库的署名策略,并注明实际贡献者。以下是 Claude 的示例;不要将其用于其他 Agent 产出的工作,也不要虚构某人的贡献:
Co-Authored-By: Claude <[email protected]>
仓库的署名和披露规则优先。不要在提交消息的标题、正文或其他任何位置添加“Generated by AI”“Written with Claude”或类似标记。
示例
简单修复
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
Co-Authored-By: Claude <[email protected]>
带范围的功能
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 格式
revert: feat(api): Add new endpoint
This reverts commit abc123def456.
Reason: Caused performance regression in production.
原则
- 每次提交都应是单一且稳定的更改
- 提交应能独立接受审查
- 每次提交后,仓库都应处于可正常工作的状态
参考资料
限制
- 仅当任务明确符合上述范围时,才使用此技能。
- 直接提交到 main 的指示仍须服从服务器端分支保护和必需检查。
- 不要将输出视为替代环境专属验证、测试或专家审查的方案。
- 如果缺少必要输入、权限、安全边界或成功标准,请停止并请求澄清。
评论
支持 Markdown