用途:为团队和智能体提供 Git 版本控制与协作的最佳实践约束,覆盖提交、分支、Pull Request 和仓库安全,优先级标注为 P0(关键)。
主要能力:
- 规范提交信息:采用 Conventional Commits 格式 <type>(<scope>): <description>,例如 feat(auth): add login validation;类型包括 feat、fix、docs、style、refactor、perf、test、chore;使用祈使语气(写 add feature 而非 added feature);一次提交只对应一个逻辑变更,禁止巨型提交。
- 分支管理:分支名使用 feat/、fix/、hotfix/、refactor/、docs/ 前缀;每个任务新建分支以保持 main 稳定可部署;禁止直接推送到 main 或 develop,须走 Pull Request;推送前先拉取以在本地解决冲突;功能分支优先用 git rebase 而非 merge 以获得线性历史;推送前可用 git rebase -i 压缩杂乱提交。
- 高质量 Pull Request:代码量控制在 300 行以内以便有效评审;说明改了什么、为什么改、如何测试,并关联 issue(如 Closes #123);请求同伴评审前先自查明显错误;合并前必须通过全部 CI 检查(lint、test、build)。
- 保护密钥与元数据:禁止提交 .env、密钥或证书,严格使用 .gitignore;可用 husky 或 lefthook 在本地强制执行 Git Hooks;发布使用 SemVer(vX.Y.Z)打标签并更新 CHANGELOG.md。
反模式:禁止直接推送到 main,所有变更一律走 PR;禁止巨型提交,大改动需拆分;历史中不得出现密钥,若已泄露可用 git filter-repo 清除并轮换密钥。
限制:资料未提供具体安装命令、配置示例、支持的平台或收费信息,暂未提供。