A guide for Code Reviewers

해당 문서는 구글소스를 기반으로 작성되었습니다.
https://chromium.googlesource.com/chromium/src/+/refs/heads/main/docs/cr_respect.md

DO

Assume competence & goodwill (능력과 선의를 가정하라)

• 비록 그들이 틀렸을지라도, 대부분 정보의 부재에서 오는 틀림이지 능력의 부재에서 오는 틀림이 아니다.

Discuss in person (직접 토론하라)

• (코드리뷰 도구를 통한 경우) 의견불일치가 있을 시, 화상미팅/대면 등 직접 토론하라

Explain why (이유를 설명하라)

• 몇몇 코드는 틀렸다는 사실이 명확하더라도, 작성자가 작성하고자 했던 방향이 아닐 수 있다. 그러므로 "이것은 틀렸습니다." 라고 말하는 대신, 어떤 방향으로 작성하는 것이 맞는지 설명하거나, 더 나은 방법은 왜 다른 방향으로 작성해야 하는지 설명하는 것이다.

Ask for the why (이유를 물어보라)

• 작성자가 코드를 특정 방법으로 작성한 이유가 불명확할때에는, 왜 해당 변경사항을 작성했는지 물어라.

Find an end (끝을 내라)

• 코드가 마음에 완전히 들지 않더라도, 계속해서 수정하기보다는 끝을 내라. LGTM가 '이 코드는 절대 실패하지 않음을 내 불멸의 영혼을 걸고 보증합니다.'라는 의미가 아니다.

Reply within a reasonable timeframe (합리적인 시간 내에 답변하라)

• 작성자가 오랜 시간 기다리도록 하지 말라

Mention the positives (긍정적으로 소통하라)

• 모든 상황에서 긍정적이거나, 거짓 미소를 지을 필요는 없지만, 좋은 결정이 잇거나 누군가가 희생하는 일이 있다면 그 일은 감사하고 좋은 일임을 인정하는 것이 좋다.

---

DON'T

Don't shame people (사람을 비난하지 말라)

• "어떻게 이것을 인지하지 못할 수 있습니까?" 하는 등의 표현은 도움되지 않는다.
• 동료가 최선을 다하지만 때때로 실수를 한다고 가정하라. 이것이 우리가 코드 리뷰를 하는 이유이다. 흠잡을 곳 없는 CL은 훌륭하지만 결함이 있는 사람이 보통이다.

Don't use extreme or very negative language (극단적/부정적인 언어를 쓰지 말라)

• 검토 중인 코드, 흑은 그 주변 코드에 대해서 "제정신인 사람은 절대 이렇게 하지 않을 것"이나, "이 알고리즘은 최악이다."는 등의 표현을 하지 않는다.
• "이것은 좋은 시작이지만 약간의 작업이 필요할 것 같습니다." 또는 "이것은 약간의 정리가 필요하다" 등의 더 긍정적이고 좋은 방식으로 표현한다.
• 사람이 아니라 코드에 대해 토론한다.

Don't discouage tool use (도구 사용을 막지말라)

• 검토자의 입장에서, 베이스코드의 일관성을 위하여 작성자가 자동화 포맷터를 사용하기를 포기하는 것에 대해 감사하라.
• 자신의 선호사항을 적용하기 전에 신중하게 생각하라.
• 사람들이 더 많은 문제를 풀기 위해 자동화봇을 사용한 것에 대해서 감사하라.

Don't bikeshed (자전거를 타지말라 → 장기적인 관점으로 생각하라)

• 항상 자기자신에게 장기적인 관점에서 이 결정이 중요한지 질문하라.
• 만약 중요하지 않다면, 동의하든 동의하지 않든, 넘어가라.