今日の英語表現 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.
ドラフトから変更した後、何が変わったのかを1行書くと、レビュアーはどこから見ればいいのかが分かります。
状況 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. 1行練習
次の韓国語の文章を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に置き換えると、プレッシャーを与えずに意見を募る表現になります。
ひとことアドバイス。 ドラフトには「いつまでか」を必ず書き添えましょう。そうすることで、レビュアーはいつ戻ってくればいいのかが分かります。
参考
- 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