Marking this as a draft: 아직 리뷰받을 준비가 안 됐다고 알리기

오늘의 영어 표현 11/30 · 단계: PR 설명. 예문은 모두 이 글을 위해 지어낸 것입니다. 실제 저장소의 PR 을 옮긴 것이 아니며, 기능 이름은 예시입니다.

목차

• 한눈에 보기
• 1. 뜻과 뉘앙스
• 2. 예문
• 3. 비슷한 표현과 차이
• 4. 한국인이 자주 하는 실수
• 5. 한 줄 연습
• 모범 답안
• 참고

한눈에 보기

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 으로 옮기면 부담을 주지 않고 초대하는 말이 됩니다.

티티 한마디. 초안에는 「언제까지」를 꼭 붙입니다. 그래야 리뷰어가 다시 돌아올 때를 압니다.

참고

• 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