diff --git a/docs/ai-reading/step7-code-commit.md b/docs/ai-reading/step7-code-commit.md index 2ba11e6..7bd0e75 100644 --- a/docs/ai-reading/step7-code-commit.md +++ b/docs/ai-reading/step7-code-commit.md @@ -505,6 +505,37 @@ mkdir -p docs/merge-requests - **监控要点**:关注 [具体的监控指标] ``` +### 🚨 合并文档不纳入Git提交 +**重要:合并文档仅用于本地记录和合并操作参考,不应加入到Git提交中!** + +#### 原因说明 +- 合并文档是临时性的操作记录,不属于项目代码的一部分 +- 避免在代码仓库中产生大量临时文档 +- 合并完成后,相关信息已体现在Git提交历史和PR记录中 + +#### 操作规范 +```bash +# ❌ 禁止将合并文档加入Git提交 +git add docs/merge-requests/ # 禁止! + +# ✅ 正确做法:确保合并文档不被提交 +# 方法1:在.gitignore中已配置忽略(推荐) +# 方法2:提交时明确排除 +git add . -- ':!docs/merge-requests/' + +# ✅ 检查暂存区,确认没有合并文档 +git diff --cached --name-only | grep "merge-requests" +# 如果有输出,需要取消暂存 +git reset HEAD docs/merge-requests/ +``` + +#### .gitignore 配置建议 +确保项目的 `.gitignore` 文件中包含: +``` +# 合并文档目录(不纳入版本控制) +docs/merge-requests/ +``` + ### 📝 独立合并文档创建示例 #### 1. 创建合并文档目录(如果不存在) @@ -689,6 +720,7 @@ git remote show [远程仓库名] - **完整性**:每次提交的代码都应该能正常运行 - **描述性**:提交信息要清晰描述改动内容、范围和原因 - **一致性**:文件修改记录必须与实际修改内容一致 +- **合并文档排除**:`docs/merge-requests/` 目录下的合并文档不纳入Git提交 ### 质量保证 - 提交前必须验证代码能正常运行