Git 黄金法则

Source: Dev.to

帮助防止 Git 仓库出错的黄金规则

黄金规则 1：绝不要强制推送

• 避免使用 git push -f 或 git push --force；它们可能覆盖其他开发者的更改并导致冲突。
• 而是正常推送，例如：

git push origin main   # 或你的远程分支名称

黄金规则 2：推送前一定要先拉取

在推送之前先拉取最新的更改：

git pull origin main   # 或你的远程分支名称

黄金规则 3：定期合并分支

• 为每个功能或 bug 修复创建单独的分支。
• 完成后将其合并到主分支：

git checkout main
git merge feature/new-feature

• 解决所有冲突后，使用以下命令暂存已解决的文件：

git add 

黄金规则 4：仔细解决合并冲突

• 使用 git status、git diff 或可视化差异工具（例如 Meld）来定位冲突。
• 手动编辑冲突文件，使用 git add 暂存它们，并进行充分测试。

黄金规则 5：提交前彻底测试

• 运行自动化测试，进行手动测试，并请求代码审查。
• 切勿提交损坏或不完整的代码。

黄金规则 6：使用有意义的分支名称和描述

• 选择清晰、具描述性的名称，例如 feature/add-login 而不是仅仅 login。
• 编写简洁的提交信息，说明更改了什么以及原因。

黄金规则 7：保持提交小且聚焦

• 避免一次性提交大量代码；将大型功能拆分为更小、逻辑上独立的提交（理想情况下每次提交不超过 10 行代码）。

黄金规则 8：定期审查并清理分支

• 定期删除陈旧的分支，清除不再需要的分支，以保持仓库整洁。

处理合并冲突的额外提示

• 中止有问题的合并：git merge --abort
• 临时暂存更改：git stash
• 与团队成员沟通冲突情况，以便共同解决。

沟通是关键

当其他人向你正在工作的分支推送更改时，保持团队知情：

1. 获取通知 – 设置仓库通知。

2. 拉取更新的分支：

   git pull origin 

3. 解决冲突（如有）并使用 git add 暂存修复。

4. 将本地更改变基到最新的更新上：

   git rebase origin/

5. 彻底测试，确保一切仍然正常运行。

协作开发的最佳实践

• 使用功能分支来隔离工作。
• 定期沟通自己正在开发的分支。
• 频繁拉取远程仓库的更新。
• 利用 Git hooks来强制执行代码规范和格式化。

使用 GitHub 自动化通知

如果你的代码托管在 GitHub 上，可以配置推送通知：

1. 前往 Repository Settings（仓库设置）。
2. 点击 Notifications（通知）。
3. 选择要监控的分支。
4. 选择通知类型（例如 push、pull request）。

遵循这些规则和实践将帮助你维护一个稳定的 Git 仓库，并营造更健康的协作环境。