关于 git-commit-suggest
用于根据 Git 变更建议提交信息的技能,先要求完成设置,再检查工作区和 diff,并按配置生成可复制的消息。它会提醒潜在秘密信息,且不执行暂存、提交或推送。
主要功能
- 01首次使用前运行配置脚本
- 02检查工作区状态与新增文件
- 03分析暂存区或工作区 diff
- 04按配置语言和格式生成消息
- 05提示可能的秘密信息
适用场景
- 01为当前代码变更拟定提交标题
- 02根据配置添加提交说明要点
- 03在建议消息前检查新增文件
- 04避免技能代为暂存或提交更改
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ wallacemaia2007/ git-commit-suggest-skill --skill git-commit-suggest安装后在 Claude Code 中输入/git-commit-suggest确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
config.example.jsonreferences/examples.mdscripts/configure.mjsoptions.mjsscripts/ui/index.html详细介绍
Git Commit Suggest
当用户要求根据 Git 更改建议提交消息时,使用此技能。
配置
首次使用时必须执行
分析任何 diff 之前,先运行 node <pasta-da-skill>/scripts/configure.mjs --print,并检查与此 SKILL.md 位于同一目录中的 config.json 里的 setupCompleted。
- 如果
setupCompleted为true,加载已配置的选项并继续。 - 如果文件不存在或
setupCompleted不为true,运行node <pasta-da-skill>/scripts/configure.mjs。用用户使用的语言告知用户配置页面已打开;如果浏览器未打开,则附上打印出的 URL。到此为止:在用户保存配置之前,不要读取 diff,也不要建议提交消息。 - 如果没有可用于打开页面的 shell,说明配置是必需的,不要使用此技能。请用户在已安装的技能目录中运行脚本,并在保存配置后重试。
取消页面操作不算完成配置。只有点击“保存”后,恢复默认设置才算完成配置。
重新配置
如果用户要求更改语言或调整技能,运行 node <pasta-da-skill>/scripts/configure.mjs 打开界面。对于简单更改,使用 --set,例如 --set language=pt-BR。
Agent 绝不能手动编辑 config.json;始终使用脚本,该脚本会验证并写入文件。
工作流
- 运行
git status --short和git ls-files --others --exclude-standard,以识别更改和新文件。 - 优先使用
git diff --cached;如果结果为空,则使用git diff。 - 阅读相关新文件的开头部分。对于大型 diff,先运行
git diff --stat;总结时忽略锁定文件、dist/、build/和*.min.*。 - 对更改进行分类,仅在明确时选择 scope。
feat、fix、refactor、perf、docs、style、test、build、ci、chore和revert等类型保持英文。 - 使用已配置的语言撰写主题和详情,并遵守
config.json中的maxSubjectLength、detailCount、bodySeparator、scope和imperativeMood。 - 检查是否有泄露密钥的迹象,并在建议提交消息之前提醒用户。
绝不要运行 git add、git commit 或 git push。提供可直接粘贴的消息,并包含已配置数量的项目符号。示例请参阅 references/examples.md。
评论
支持 Markdown