用途:这是一套 Git 工作流与提交信息规范,适用于提交代码、创建分支或创建拉取请求的场景,帮助团队统一分支与提交习惯。
分支策略:采用 GitHub Flow;主分支始终保持可部署状态;从 main 创建功能分支;分支名需具描述性,例如 feature/add-auth、fix/login-bug。
提交规范:采用 Conventional Commits 前缀,包括 feat:(新功能)、fix:(缺陷修复)、docs:(仅文档)、style:(格式化,不改代码逻辑)、refactor:(既非新功能也非修复的代码改动)、test:(新增或更新测试)、chore:(维护、依赖)。
提交最佳实践:信息清晰简洁;重点说明“为什么”而非“做了什么”;保持原子提交(一次只含一个逻辑改动);提交前运行测试;绝不提交密钥或凭据。
提交前检查清单:运行测试 pytest;格式化代码 ruff format .;代码检查 ruff check .;查看改动 git diff。
拉取请求:使用描述性标题;包含改动摘要;引用相关 issue;邀请相关团队成员评审。
禁止提交的文件:含密钥的 .env 文件、credentials.json、API 密钥或令牌、大型二进制文件、IDE 专属文件(除非是团队共享配置)。资料未提供安装方式、收费与价格、平台支持及自动化执行等细节。