Community写作与编辑github.com

BOUAHMEDimane/cursor-commit-message-helper

Cursor 智能体技能,用于编写符合规范的提交信息

cursor-commit-message-helper 是什么?

这是一个为 Cursor Agent 设计的技能,帮助开发者撰写规范化的 Conventional Commits 格式提交信息。它提供了完整的类型定义(如 feat、fix、docs 等)和严格的编写规则(如主题行不超过 72 字符、使用祈使语气)。该技能通过引导开发者运行 `git diff --staged` 查看暂存更改,然后识别主要类型和范围,最终生成结构化的提交信息。支持多种主流平台(Cursor 等),适用于任何采用 Conventional Commits 标准的项目,能显著提升代码协作的效率与一致性。

兼容平台~Claude Code~Codex CLI✓Cursor
npx skills add BOUAHMEDimane/cursor-commit-message-helper

Installed? Explore more 写作与编辑 skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

在你喜欢的 AI 中提问

打开一个已预加载此 Agent Skill 的新对话。

文档

提交信息助手

格式

遵循 Conventional Commits 规范:

<类型>(<可选范围>): <描述>

[可选正文:解释 WHY,而非 WHAT]

类型

类型用途
feat新功能
fix修复 bug
docs仅文档改动
style格式调整,无逻辑变化
refactor代码重构,无新功能或修复
test添加或更新测试
chore维护工作(依赖、配置)

规则

  1. 主题行:最多 72 字符,使用祈使语气(“add” 而非 “added”)
  2. 范围可选但推荐(例如 auth、api、ui)
  3. 正文解释 why,而非 what(diff 会展示 what)
  4. 每个提交只包含一个逻辑变更

工作流程

  1. 运行 git diff --staged 查看暂存更改
  2. 确定主要类型和范围
  3. 草拟提交信息
  4. 验证:主题 ≤ 72 字符、祈使语气、若逻辑非明显则解释 why

示例

功能: feat(auth): 添加 JWT 令牌刷新端点

防止用户在长时间会话期间被登出

Bug 修复: fix(reports): 修正时区转换中的日期格式化

时间戳以本地时间显示,而非 UTC

文档: docs: 在 README 中添加设置说明

相关技能