Community写作与编辑github.com

提交 (Commit)

创建范围明确的 Git 提交,并使用约定式提交消息。当用户要求提交、保存工作、“交付这个”、或完成一个变更并希望记录到 Git 中时,请使用此技能,即使他们没有明确说“提交”。在编写或重写提交消息时也应使用。

提交 (Commit) 是什么?

该技能实现了一个严谨的 Git 提交工作流,专注于创建范围明确且具有信息量的提交,并强制使用约定式提交消息格式。它指导 AI 智能体在提交前查看工作区状态,检查敏感数据,并启动有选择性的暂存过程,以保持每个提交只包含一个逻辑变更。提交消息遵循 `<type>(<scope>): <summary>` 格式,正文解释变更原因而不只是展示变更内容,并包含可选的引用或关闭票据的页脚。该技能适用于任何 Git 工作流,在 Claude Code、Cursor、Codex 等 AI 编程助手中可优化代码审查和项目历史可读性。它通过 heredoc 执行提交以确保多行消息不被 shell 破坏,并避免强制推送,除非用户明确要求,从而帮助开发者生成可在关键调试场景下阅读的清晰、可审计的提交历史。

兼容平台✓Claude Code~Codex CLI~Cursor
npx skills add https://github.com/mdesoeuv/claude_skills/tree/HEAD/skills/commit

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

在你喜欢的 AI 中提问

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

文档

提交 (Commit) 是做什么的?

提交是某人在压力下、在事故期间、一年后所读到的最小历史单元。请为这样的读者优化。

工作流程

  1. 提交前先查看:git status、git diff --staged、git diff。绝不盲目提交。
  2. 检查是否有任何不可提交的内容:凭据、.env 文件、私钥、大型二进制文件、调试打印语句、注释掉的代码。如果发现,停止并告知用户。参见 secrets-hygiene 技能。
  3. 有选择地暂存。优先使用 git add <路径> 而不是 git add -A。每个提交只包含一个逻辑变更;如果变更混合了重构和功能,则拆分。
  4. 按照以下格式编写消息。
  5. 使用 heredoc 提交,这样多行正文才能在 shell 中存活:
git commit -m "$(cat <<'MSG'
feat(auth): 为管理控制台添加 OIDC 登录

用 Cognito 支持的 OIDC 替代了共享的基本认证密码,以便可以按用户撤销访问权限。会话 8 小时后过期。

Refs: PLAT-412
MSG
)"
  1. 用 git log -1 --stat 确认。除非用户明确要求,绝不修改或强制推送。

消息格式

<类型>(<范围>): <祈使句摘要,≤72 字符,末尾无句号>

<为何存在此更改,而不是差异显示的内容——差异已经显示了那个>

<页脚:Refs/Closes 工单,BREAKING CHANGE: ...,Co-Authored-By>

类型:feat、fix、refactor、perf、test、docs、build、ci、chore、revert。 范围是所涉及的模块、服务或栈(api、terraform/vpc、ci)。当变更是全局性的时省略范围。

正文比摘要更重要。用两到四句话回答“为什么现在?”和“我们考虑了哪些方案?”。对于琐碎的更改,一行提交也可以。

示例

输入:修复了 S3 存储桶没有标签时的空指针异常 输出:fix(s3-inventory): 处理没有标签集的存储桶

输入:将 Terraform AWS 提供程序从 5.40 升级到 5.60,新的 Lambda 运行时属性需要此版本 输出:

build(terraform): 将 AWS 提供程序升级到 5.60

`aws_lambda_function.runtime = "python3.13"` 需要此版本。所有栈上的 `terraform plan` 没有资源差异。

当给定 $ARGUMENTS 时

将其视为用户给出的范围或摘要提示,但仍需检查差异并纠正它,如果它与实际更改不匹配。

Individual skills in this repo

This repo contains 2 individual skills — each has its own dedicated page.

相关技能