Skip to content

코드 리뷰 컨벤션

Lia edited this page Oct 2, 2022 · 1 revision

코멘트 라벨링

[P1] ~ [P5] 와 같은 형태로 고멘트 앞에 달아주시면 됩니다.

뱅샐 참고

  • P1: 꼭 반영해주세요 (Request changes)

    리뷰어는 PR의 내용이 서비스에 중대한 오류를 발생할 수 있는 가능성을 잠재하고 있는 등 중대한 코드 수정이 반드시 필요하다고 판단되는 경우, P1 태그를 통해 리뷰 요청자에게 수정을 요청한다. 리뷰 요청자는 p1 태그에 대해 리뷰어의 요청을 반영하거나, 반영할 수 없는 합리적인 의견을 통해 리뷰어를 설득할 수 있어야 합니다.

  • P2: 적극적으로 고려해주세요 (Request changes)

    작성자는 P2에 대해 수용하거나 만약 수용할 수 없는 상황이라면 적합한 의견을 들어 토론할 것을 권장합니다.

  • P3: 웬만하면 반영해 주세요 (Comment)

    작성자는 P3에 대해 수용하거나 만약 수용할 수 없는 상황이라면 반영할 수 없는 이유를 들어 설명하거나 다음에 반영할 계획을 명시적으로(JIRA 티켓 등으로) 표현할 것을 권장한다. Request changes 가 아닌 Comment 와 함께 사용됩니다.

  • P4: 반영해도 좋고 넘어가도 좋습니다 (Approve)

    작성자는 P4에 대해서 해당 의견을 반영하는 게 좋을지 고민해 보는 정도면 충분합니다.

  • P5: 그냥 사소한 의견입니다 (Approve)

    작성자는 P5에 대해 깊이 고민하지 않아도 괜찮습니다.

추가 규칙

  • 2 approve
  • ⭐️리뷰 의견 낼 때, 근거도 함께 쓰기
  • 의견을 받아들일지는 코드를 작성한 사람이 결정하기
  • 반영 완료한 리뷰는 리뷰어가 resolve 하기
  • task 최대한 잘게 나눠서 리뷰하기 편하게 PR 날리기 (양심 코딩 : +-400)
  • 멋진 코드 칭찬하기
  • 궁금한 건 편하게 리뷰로도 물어보기