41 lines (30 loc) · 1.96 KB

AI 协作说明

本文件用于约束 AI 编程工具在本仓库中的通用协作方式。

权威参考

Git 工作流以 docs/git-workflow.md 为准。
如果 AI 的默认做法与 docs/git-workflow.md 冲突，必须优先遵循 docs/git-workflow.md。

Git 分支与流程要求

不要直接向 main 推送代码。
优先使用“分支 + Pull Request / Merge Request”流程提交改动。
main 视为生产分支。
develop 视为默认开发集成分支。
新功能分支使用 feature/<name> 命名，并从 develop 创建。
发布准备分支使用 release/<version> 命名，并从 develop 创建。
紧急修复分支使用 hotfix/<issue-id> 命名，并从 main 创建；修复完成后需要按规范同步回 main 和 develop。

AI 在执行 Git 操作前必须做的事

在创建分支、提交、合并、推送前，先检查当前仓库状态，并结合 docs/git-workflow.md 决定操作方式。
当用户要求执行 Git 操作时，优先采用本仓库定义的分支模型，不要自行假设流程。
创建 PR / MR 时，目标分支应与工作类型匹配：
- 功能开发 -> develop
- 发布分支 -> 按文档流程合并到 main，再回合并到 develop
- 热修复 -> 先合并到 main，再回合并到 develop
除非用户明确要求，否则不要改写已发布历史。
不要对受保护分支执行 force push。

开发与验证要求

改动应尽量聚焦、最小化。
遵循现有项目结构和代码风格。
修改代码后，尽可能运行相关测试。
当行为、配置、工作流发生变化时，同步更新文档和示例。

给后续 AI 的补充说明

即使当前远端还没有完整的长期分支，也应优先按 Git Flow 的方向理解本项目。
如果当前仓库实际分支状态与文档不完全一致，并且该差异会影响发布、部署或合并策略，应先询问用户，再做不可逆的 Git 决策。