Git 与 PR 工作流规范

核心原则

• 小规模 PR：理想情况下，单个 PR 修改代码行数（LOC）≤300 行
• 频繁提交：尽早提交、有意义的提交，并附带清晰明确的提交信息
• 线性历史：优先使用 rebase，避免产生 merge commit
• 专业性：不得包含任何 AI 归属信息，不得体现工具品牌，描述需简洁专业

🚨 绝对零容忍规则：严禁 AI 归属声明 🚨

在以下任何场景中，均严禁出现以下内容（无论何种情况）：

• Git 提交信息（commit messages）
• Pull Request 描述（PR descriptions）
• Issue 评论（issue comments）
• GitHub Discussions
• 代码注释（code comments）
• 文档（documentation）
• 任何面向公众的仓库内容

❌ 严格禁止的文本 —— 绝对不可使用

• "Claude"
• "Anthropic"
• "claude.com"
• "Claude Code"
• "Claude Desktop"
• "Generated with Claude"
• "Co-Authored-By: Claude"
• "🤖 Generated with Claude Code"
• "Co-Authored-By: Claude "
• 任何 emoji 后接 "Generated with" 或 "Powered by"
• 任何关于 AI 助手、AI 代码生成或自动化工具的提及
• 任何第三方 AI 服务的品牌标识、归属声明或链接

✅ 正确格式 —— 必须始终采用

• 简洁、专业的提交信息
• 清晰说明本次变更的内容
• 解释此次变更的原因
• 不包含归属声明、不体现品牌、不引用工具

示例

❌ 禁止的提交信息

Add multi-dimension vector support

- Support for 384, 768, 1024, and 1536 dimensions
- Update validation logic for new dimensions
- Add comprehensive test coverage

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude 

✅ 正确的提交信息

Add multi-dimension vector support

- Support for 384, 768, 1024, and 1536 dimensions
- Update validation logic for new dimensions
- Add comprehensive test coverage

❌ 禁止的 PR 描述

## Summary
Implemented new authentication flow with JWT tokens.

## Test Plan
All tests passing.

---
🤖 Powered by Claude

✅ 正确的 PR 描述

## Summary
Implemented new authentication flow with JWT tokens.

## Test Plan
All tests passing.

执行机制

• 零容忍 规则，无任何例外
• 每次提交前必须完成自查验证
• 每次创建 PR 前必须审查是否含归属信息
• 如发现归属信息，须立即通过强制推送（force push）或 amend 方式移除
• 本规则适用于所有仓库、所有项目、所有提交
• 违规行为将损害我们工作的专业形象

为何此项至关重要

• 维护仓库的专业外观
• 避免非预期的第三方归属声明
• 确保我们的工作成果被视作团队原创产出
• 防止作者身份与所有权归属产生混淆
• 符合公司品牌规范要求

PR 必备要素

每个 PR 必须包含以下内容：

• 问题/背景（Problem/Context）：我们正在解决什么问题？为何需要解决？
• 解决方案概要（Solution summary）：本次变更如何解决该问题？
• 测试方案（Test plan）：验证功能所用命令及对应结果
• 风险与回滚（Risk/rollback）：潜在风险点及必要时的回退方式
• 需求链接 + 类型 + 预估工时（Story link + Type + Estimate）：关联的需求/故事链接，类型（feature/bug/chore），以及预估点数

参考文件

详见 references/ai-attribution-enforcement.md，其中列出了完整禁用文本清单及执行细则。

详见 references/pr-templates.md，其中提供了 feature、bug 和 chore 类型 PR 的完整模板。

详见 references/branch-conventions.md，其中定义了分支命名规范及示例。