返回资讯中心
外部精选
软件工程
#开发者实时流

Maiao 社区分支:让 stacked diffs 在 GitHub 上更好用

来源标题:Stacked Diffs with Maiao

作者使用 Maiao 社区分支后表示,它让偏好 stacked diffs 的开发者也能顺畅对接 GitHub 等传统代码托管平台。作者称 Maiao 在几乎所有场景下都能正确处理,至少把他在 GitHub 上的挫败感减半。文章随后介绍了传统平台上基于 pull request 和分支的代码评审流程作为背景。

Hacker News 最新aray072026/11/17 · 今天30 分钟阅读

以下正文由 AI 翻译自 Hacker News 最新(原文版权归原站所有),可能存在偏差,重要内容请以原文为准。

我使用 Maiao 的社区 fork 已经有一段时间了,它非常出色。如果有人喜欢用 stacked diffs 的方式工作,但又需要与 GitHub 这类更传统的 forge 平台打交道,不妨试试 Maiao。几乎在所有情况下,它都能做出正确的处理。它至少把我对 GitHub 的挫败感减少了一半,甚至更多。

对于那一小群对 stacked diffs 感到兴奋的读者来说,这大概已经足够了。对于其他人,我们稍微从头讲起。

在传统的 forge 平台上(比如 GitHub、Codeberg、GitLab、BitBucket 等),pre-commit 代码审查发生在 pull request(有时也叫 merge request)上,每个 pull request 都从一个 git 分支创建。这里的 pre-commit 指的是代码被合并(“提交”)到上游分支之前进行的审查,与之相对的是审计之类的 post-commit 审查。

刚接触 git 的用户可以把一个分支理解为朝着一个小目标推进的一项开发工作。只要分支顶端还没有达到目标状态,他们就不断往这个分支上添加 commit。最后,当一切看起来都没问题、变更也获得批准时,他们执行一次显式的 merge。这意味着他们在上游分支上创建一个 merge commit,同时引用旧的上游和他們工作的那个分支。

这让初学者能够以小步增量推进,而不必处理重写 git 历史的复杂细节,从而降低了使用 git 与他人协作的门槛,这很好。有时初学者会被建议改用 squash merge,这通常意味着 forge 平台在上游分支上创建一个普通的 commit,只引用旧的上游,并包含开发分支顶端所隐含的全部变更。虽然听起来像是在重写历史,其实并不是——旧的开发分支仍然和之前完全一样。区别在于,它所隐含的变更被复制到了上游分支,而没有引用开发分支。

这也意味着传统 forge 的审查界面不必处理重写 git 历史的复杂细节。因此,审查界面通常只展示仍在开发分支上的 commit 之间的差异,而不展示“同一个” commit 的两个版本之间的变化——当其中一个版本已不在分支上时。

▲ (upstream)
│
│ ▲ (input-validation)
│ │
│ │ ▲ (priv-cache)
│ │ │
│ ● │ Tighten input validation
│ │ │
│ │ ● Rename cache variables
│ │ │
│ │ ● Cache user permissions
├───╯ │
●◀──╮ │ Merge flaky-test-fix (PR #835)
│ ├───╯
│ ● Fix timezone offset instead
│ │
│ ● Disable login test
│ │
●◀──┼───╮ Merge log-migration (PR #834)
├───╯ │
●◀──╮ │ Merge avatar-upload (PR #833)
│ │ │
│ ● │ Fix typo in readme
│ │ │
│ ● │ Clean up unused imports
│ │ │
│ ● │ Add avatar upload
├───╯ │
●◀──╮ │ Merge parser-null-check (PR #832)
│ │ │

我们可以看到总共 12 个 commit。其中四个是上游分支上的 merge commit,这四个中有两个对应着我们可以看到工作内容的分支(avatar-upload 和 flaky-test-fix)。可以看到,这两个分支上分别有两个和三个实际工作的 commit。另外还有两个分支(input-validation 和 priv-cache)仍然开放(未与上游合并)。其中一个(priv-cache)有两个工作 commit,它不是基于上游分支,而是基于较早的某个分支(flaky-test-fix)在被合并之前的最终结果。

我们不必这样使用 git。我们可以改为只用一个开发分支。我把它叫做一个通用的名字,比如 dev。在这个分支上,每个目标状态由一个 commit 表示。于是,不再是多个分支(每个目标一个分支)、每个分支上有多个 commit(实现目标的步骤),而是一个分支(一个通用开发分支),上面有多个 commit(每个目标一个)。

在这种工作流下,如果我们发现某个 commit 并不代表那次变更的目标状态,我们就编辑那个 commit,而不是再添加更多 commit。技术上来说,git 并不让用户编辑 commit。底层发生的事情是,该 commit 被替换为一个新的 commit。但借助 commit message 中的 change id,我们仍然可以分辨出它们代表同一个原子变更。那如果需要回到旧的 commit 呢?幸运的是,git 维护着一个包含旧 commit 的 reflog。这些 commit 会一直保留,直到 git 决定垃圾回收悬空的引用。这样,每个进行中的原子变更都恰好在一个 commit 中实现,全部在同一个开发分支上。dev 分支可能有很多 commit,但它们代表不同的原子变更,而不是朝一个目标状态推进的过程。

这种工作方式也被称为制作 stacked diffs,我觉得它比每个原子变更单独开一个分支更容易、更快捷。许多经验丰富的软件工程师也同意这一点。我得说,我不同意 Gergely Orosz 的说法——他认为不可能创建一个依赖于较早的、尚未合并的 pull request 中变更的 pull request。这是可能的(在大多数 forge 里甚至很容易),但要兼顾分支和合并目标需要大量额外工作。从根本上说,pull request 和 stacked diffs 之间并没有深层的不兼容。人们偏爱为 stacked diffs 打造的工具,原因在于用这些工具时,满足 git 所需要的“文书工作”更少。

合并 stacked diffs 的理想方式是把它们复制到上游分支,可以通过 cherry-pick,或者在 forge 界面中选择 rebase 和 fast-forward 的合并类型。这样产生的上游分支历史会非常清晰地按发生顺序列出每个原子变更,而不包含中间的误步和错误。

(原文较长,此处译出前 6000 字,完整内容请点「打开原文」。)

正文由 探How 从来源站点 RSS 同步,内容未经改写;遇到排版缺失或需要图片、视频时请以原文为准。

打开原文
去社区讨论 →