Squash 合并

Squash 合并可以将多个提交合并成一个,以便在合并后只生成一个新提交,以保持清晰的提交历史。这可以帮助项目保持干净的提交历史,而不会因为大量小提交而变得混乱。

通常,Squash 合并用于将一个功能或修复合并到主分支时,以便保持提交历史的连贯性。

如何使用 Squash 合并

Squash 合并非常简单:

确保开启了 Squash 合并:进入 GitCode 项目,点击“项目设置”选项卡,并在“Pull Requests-合并模式”中启用了“通过 merge commit 合井”

打开Pull Requests:进入 GitCode 项目,然后选择要执行 Squash 合并的Pull Requests

启用 Squash 合并选项:在Pull Requests“讨论”选项卡的下方,你将看到 Squash 合并的复选框

编辑提交描述:为合并提交提供一个清晰的描述,以便其他开发者了解合并的目的和更改

完成合并:点击「合入」 按钮,GitCode 将合并多个提交并生成一个新的提交

Squash 合并的限制

尽管 Squash 合并是一个有用的工具,但它也有一些限制:

  • 丢失提交历史:Squash 合并会创建一个新的提交,而丢弃了原始提交的详细历史信息
  • 不适用于所有情况:Squash 合并通常用于合并功能或修复,但不适用于所有项目或情况

最佳实践

以下是使用 Squash 合并功能的最佳实践:

  • 清晰描述:在提交描述中提供清晰的信息,以便其他开发者了解合并的目的和更改
  • 适度使用:Squash 合并应谨慎使用,避免在不必要的情况下合并提交
  • 保留重要历史:如果某些提交包含重要历史或决策信息,请考虑将其保留在提交历史中

Squash 合并功能可以更好地管理提交历史,使项目的版本控制和代码审查更加清晰和有序。