今日英语表达 11/30 · 阶段:PR 描述。 所有例句均为本文特意编写,并非摘自实际仓库的 PR,功能名称仅为示例。
目录
一览
| 表达 | Marking this as a draft until ... / This is ready for review. |
| 含义 | 在...之前保持草稿状态 / 现在可以开始评审了。 |
| 使用场景 | PR 描述开头、PR 评论、Slack |
| 语气 | 中性。用于告知状态 |
1. 含义与语感
draft 即「草稿」。根据 GitHub 文档,draft PR 无法合并,且不会自动向代码所有者(code owners)发送评审请求。准备就绪后,可以将其更改为 Ready for review,此时才会向代码所有者发送评审请求。也可以随时将其重新切回草稿状态。
因此,开启 draft 意味着发出 「欢迎查看,但暂不需要仔细评审」的信号。通常在想先确认方向是否正确、想查看 CI 结果、或者等待前置 PR 合并时使用。此时一起写下 正在等待的内容(until ... )是核心所在。如果无缘无故地保持草稿状态,评审人员将无法得知何时该再次查看。
Kubernetes 贡献指南建议在尚未准备好评审的 PR 标题中添加 WIP 或 [WIP]。WIP 是 work in progress(进行中的工作)的缩写,Prow 机器人会为其添加 do-not-merge/work-in-progress 标签以阻止合并。此外, /hold 命令会添加 do-not-merge/hold 标签,以防止即使是已批准的 PR 也被合并。当面对大型变更或自动生成的变更等没有十足把握的情况时,也可以开启 Draft PR 并寻求指导。
2. 例句
场景 1:PR 描述开头
Marking this as a draft until #3200 is merged, since this PR builds on top of it. Early feedback on the API shape is welcome.
builds on top of 意为「在……之上构建」,即依赖于前置 PR。Early feedback is welcome 意为「欢迎早期反馈」,明确了开启草稿的目的。
场景 2:准备工作完成时
This is now ready for review. I've rebased onto main and added unit tests for the new validation.
从草稿状态更改后,简要说明有哪些改动,可以让评审人员知道从哪里开始看起。
场景 3:在 Slack 中询问方向时
I opened a draft PR for the snapshot export feature. It's not ready for a full review yet, but I'd appreciate a quick look at the overall approach.
3. 类似表达与区别
- WIP / [WIP]. 添加在标题中的标记。这是在 GitHub 的 draft 功能出现之前就一直使用的惯例,在某些像 Kubernetes 这样机器人会读取该标记的仓库中依然适用。
- Not ready to merge yet. 意为可以接受评审,但请等待合并。与 draft 不同,这里会正式请求评审。
- /hold. 在使用 Prow 的仓库中仅用于阻止合并的命令。要解除时使用
/hold cancel。
4. 韩国人常犯的错误
- Not completed yet. Please wait. 没有说明在等待什么,也没有说明何时结束。
- 修改后的句子:Marking this as a draft until the e2e tests pass.
- Please don't review this PR. 在公开仓库中任何人都可以看到,因此使用否定命令会显得生硬。
- 修改后的句子:This isn't ready for a full review yet, but early feedback is welcome.
- I changed it to ready. ready 后面漏掉了准备好做什么。
- 修改后的句子:I've marked this as ready for review.
5. 一行练习
请将以下韩语句子改写为 PR 描述的开头。
在文档编写完成之前保持草稿状态。现在就可以给出关于代码方面的意见。
参考答案
Marking this as a draft until the docs are done. Feedback on the code is welcome in the meantime.
in the meantime 意为「在此期间」。将「现在就可以给出」译为 is welcome,会成为一种既不给对方压力又表示欢迎的说法。
Titi 小贴士。 草稿一定要加上「到什么时候为止」。这样评审人员才能知道什么时候回来查看。
参考资料
- GitHub Docs, About pull requests(Draft pull requests): https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests
- Kubernetes 贡献指南, Pull Request Process(WIP, /hold): https://github.com/kubernetes/community/blob/master/contributors/guide/pull-requests.md