Nit: 사소한 지적이라고 미리 알려 주는 머리말

오늘의 영어 표현 14/30 · 단계: 리뷰 받기·답하기. 예문은 모두 이 글을 위해 지어낸 것입니다. 실제 저장소의 댓글을 옮긴 것이 아니며, 변수 이름은 예시입니다.

목차

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

한눈에 보기

1. 뜻과 뉘앙스

nit 는 nitpick(사소한 흠을 잡다)에서 온 말입니다. 리뷰 댓글 앞에 Nit: 을 붙이면 「이것은 사소한 지적입니다」라는 뜻이 됩니다. 오타, 변수 이름, 빈 줄, 주석 문장처럼 동작에는 영향이 없지만 다듬으면 좋은 것들입니다.

Google 의 코드 리뷰 지침은 댓글의 무게를 밝히는 머리말로 Nit 을 예로 들고, 「사소한 일이다. 기술적으로는 고치는 것이 맞지만 큰 영향은 없다」는 뜻이라고 설명합니다. 같은 지침은 Optional(또는 Consider)과 FYI 도 함께 소개합니다. 이렇게 머리말을 달면 작성자가 모든 댓글을 반드시 고쳐야 하는 것으로 오해하지 않고, 무엇부터 할지 정할 수 있습니다.

Nit 을 받은 작성자는 대개 고칩니다. 금방 고칠 수 있는 일이기 때문입니다. 다만 Nit 은 병합을 막는 지적이 아니므로, 이유가 있으면 고치지 않고 짧게 설명해도 됩니다. 반대로 리뷰어가 Nit 을 너무 많이 달면 작성자가 지칠 수 있어서, 사소한 것을 여러 개 모아 「nits」라고 한 댓글로 묶기도 합니다.

19편의 Not a blocker 와도 이어집니다. 「LGTM with a few nits」라는 말은 「사소한 것 몇 개만 빼면 좋다」, 곧 큰 문제는 없다는 뜻입니다.

2. 예문

상황 1: 리뷰어의 줄 댓글

Nit: cfg → config would be more consistent with the rest of the package.

상황 2: 작성자의 답글

Done, thanks!

Nit 에 대한 답은 짧을수록 좋습니다. 고쳤으면 Done 이나 Fixed 한 단어로 충분합니다.

상황 3: 고치지 않기로 할 때

I kept cfg here because the same name is used in the generated client, and I'd rather not diverge from it. Happy to change it if you feel strongly.

if you feel strongly 는 「꼭 바꾸길 원하시면」이라는 뜻으로, 결정을 리뷰어에게 넘기며 정중하게 마무리합니다.

3. 비슷한 표현과 차이

• Optional: / Consider: ... 「좋은 생각이지만 필수는 아니다」라는 제안입니다. Nit 보다 무게가 조금 더 있지만 역시 병합을 막지 않습니다.
• FYI: ... 「이번에 하라는 것은 아니고, 참고로 알아 두면 좋다」는 정보입니다.
• Super nit / Nitpick. 아주 사소하다는 것을 더 강조합니다. Super nit 는 비격식입니다.

4. 한국인이 자주 하는 실수

• I'm so sorry for my mistake. I will be more careful. Nit 하나에 크게 사과하면 리뷰어가 오히려 부담을 느낍니다.
  • 고친 문장: Good catch, fixed.
• 작성자가 Nit 을 아무 답 없이 무시하기. 고치지 않을 때도 짧은 이유를 남기는 것이 예의입니다.
  • 고친 문장: Leaving this as is to match the existing naming, if that's okay.
• 리뷰어가 되어 Nit 을 빼고 단정적으로 쓰기. You should rename this. 는 반드시 고쳐야 하는 지적처럼 읽힙니다.
  • 고친 문장: Nit: maybe rename this to podName?

5. 한 줄 연습

리뷰어 입장에서 다음 내용을 줄 댓글로 쓰십시오.

사소한 건데요, 이 주석에 오타가 있습니다(recieve 를 receive 로).

모범 답안

Nit: typo, "recieve" → "receive".

Nit 댓글은 문장을 길게 만들지 않는 것이 관례입니다. 화살표(→)로 바꿀 내용을 바로 보여 주면 충분합니다. GitHub 의 suggestion 기능을 쓰면 작성자가 버튼 하나로 반영할 수도 있습니다.

티티 한마디. Nit 은 「사소하다」는 배려입니다. 받은 쪽도 짧게, 가볍게 답하면 됩니다.

참고

• Google Engineering Practices, How to write code review comments(Label comment severity): https://google.github.io/eng-practices/review/reviewer/comments.html
• Merriam-Webster, 「nitpick」: https://www.merriam-webster.com/dictionary/nitpick