mcpField
C
checkpoint

checkpoint

github.com/leonvanzyl开发45037 次安装22 周前更新
代码仓库

关于 checkpoint

checkpoint 是用于创建本地 Git 检查点提交的开发技能。它先检查改动并要求 lint、类型检查和构建通过,再按仓库惯例暂存并提交所有改动。

主要功能

  1. 01检查 Git 状态、差异和近期提交
  2. 02运行 lint、类型检查与构建
  3. 03提交前暂存所有改动
  4. 04按规范编写提交信息和协作者署名
  5. 05报告提交及改动统计

适用场景

  1. 01为代码改动创建检查点
  2. 02提交前验证项目检查项
  3. 03按仓库惯例准备提交

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/leonvanzyl/agentic-coding-starter-kit --skill checkpoint

安装后在 Claude Code 中输入/checkpoint确认已加载。

详细介绍

检查点提交

创建一个检查点提交,纳入所有当前更改,但必须先确保代码通过 lint、类型检查和构建。

说明

第 1 步:分析更改

运行以下命令,全面了解当前情况:

  1. git status — 查看所有已跟踪和未跟踪的文件
  2. git diff — 查看已跟踪文件的详细更改
  3. git diff --cached — 查看已暂存的更改
  4. git log -5 --oneline — 了解此仓库的提交消息风格
第 2 步:质量检查

运行全部三项检查。如果任何一项失败,请先修复问题再继续,不要跳过或忽略失败。

  1. npm run lint — 修复任何 lint 错误
  2. npm run type-check — 修复任何类型错误(如果没有此脚本,请尝试 npx tsc --noEmit)
  3. npm run build — 修复任何构建错误

反复检查,直到三项都顺利通过。只有全部通过后,才能进入下一步。

第 3 步:暂存所有更改

暂存所有更改,包括已跟踪文件的修改、删除以及新的未跟踪文件:

git add -A
第 4 步:拟定提交消息

根据项目现有惯例(从 git log 中查看)编写提交消息。格式如下:

  • 首行:使用祈使语气,清晰简洁地概括内容(50–72 个字符)
    • 如果项目使用 Conventional Commits 前缀,请使用:feat:、fix:、refactor:、docs:、chore: 等。
  • 正文(与首行空一行):简要概述更改,最多 1–3 句话。不要使用项目符号列表,不要逐个文件说明,也不要长篇解释。
  • 页脚:共同作者署名
第 5 步:提交

使用 heredoc 创建提交,以确保格式正确:

git commit -m "$(cat <<'EOF'
{first line}

{tldr}

Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
EOF
)"
第 6 步:报告

显示:

  • 提交哈希和消息摘要
  • 更改的文件数量
  • 新增/删除行数摘要

重要事项

  • 暂存并提交所有内容;除非文件明显包含敏感信息(.env、凭证),否则不要跳过
  • 如果仓库没有 Git 历史记录,请先运行 git init
  • 提交前必须通过所有质量检查(lint、类型检查、构建);修复问题,不要跳过检查
  • 保持提交正文简短,只写摘要,不要写成文章
  • 遵循项目现有的提交惯例(先查看日志)
  • 不要推送,只在本地提交

评论

支持 Markdown