Git Conventions 是一套面向个人仓库的共享 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 这样的栈前缀,因为分支在合并时会被删除。避免使用长破折号和装饰性 emoji。
使用方式 该约定以文档形式提供,供个人仓库在初始化或日常提交时参照执行。具体安装或集成方式暂未提供。
适用场景 适用于个人维护的多个仓库,尤其是需要统一远程命名、提交格式和写作风格的场景。
限制 该约定面向个人仓库,未说明是否适用于团队或组织仓库。具体工具支持、自动化程度和强制方式暂未提供。