关于 git-conventions
git-conventions 是一项仓库技能,规定远程仓库、提交与 PR 标题、worktree 和写作风格的约定,帮助统一 Git 操作及仓库历史记录。
主要功能
- 01按托管平台命名远程仓库
- 02提交与 PR 标题格式
- 03worktree 位置约定
- 04仓库写作风格
适用场景
- 01设置仓库远程地址
- 02撰写提交或 PR 标题
- 03选择 worktree 位置
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ klausborges/ workflow-skills --skill git-conventions安装后在 Claude Code 中输入/git-conventions确认已加载。
附带文件agents/openai.yamlskill.toml
详细介绍
Git 约定
远程仓库
- 按托管平台为远程仓库命名:GitHub 使用
github,个人 Forgejo 实例使用forge。绝不使用origin。 - 尽可能配置这两个远程仓库;第二个用作备份镜像。
- 每个仓库在设置时选择一个主远程仓库。主远程仓库负责 CI 和拉取请求,也是对话中“origin”所指的仓库。默认主远程仓库:
github。
提交和 PR 标题
第一行采用 type(scope): description 格式,scope 可选。类型:feat、fix、docs、ci、build、chore、refactor、test、perf、revert。
工作树
工作树为可选项。手动创建的工作树放在 <repo>/.worktrees/<branch> 中,分支名中的斜杠替换为短横线,并确保该目录保持在 gitignore 中。原生框架的工作树目录(例如 Claude Code 的 .claude/worktrees/)也完全可以。项目文件夹中不要放置裸露的工作树同级目录。
写作风格
- 使用简洁的句子,并以句号和逗号标点;标题采用句首字母大写格式。
- 为仓库中可长期保留的历史记录而写:描述变更本身,不要描述计划、里程碑或阶段。分支名称可以保留
m2/prng这样的栈前缀,因为合并时会删除分支。 - 不使用破折号和装饰性表情符号。
评论
支持 Markdown