Code Review Convention

• 리뷰이의 멋진 코드에 대해 칭찬한다.

• 궁금한 점은 편하게 리뷰로 물어본다.

• 리뷰어의 의견에 대해 받아들일지는 리뷰이가 선택한다.

• 리뷰어는 리뷰할 때, 리뷰에 대한 근거도 함께 작성한다.

• 리뷰이는 리뷰어에게 받은 리뷰에 대해 아무리 사소한 의견이라도 반드시 답하도록 한다.

• 코드 리뷰에 뱅크 샐러드의 Priority Rule을 적극 활용한다.

• 코드에 대한 피드백을 할 때, 정답을 알려주는 것은 피드백이 아님을 명심한다. 피드백은 방향성을 제시하는 것으로, 키워드를 짚어주는 쪽으로 피드백하는 것을 지향한다.

• 리뷰할 때는 명확하게 문제점을 짚어주되, 리뷰이의 기분이 나쁘지 않도록 리뷰한다.

• 리뷰어는 리뷰에 대한 근거를 명확하게 작성하도록 한다.

• 리뷰이는 리뷰어의 리뷰가 잔소리가 아님을 명심한다. 또한, 리뷰는 리뷰어가 리뷰이를 위해 귀한 시간을 투자하는 것임을 반드시 명심한다.

Priority Rule

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

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

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

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

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

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

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

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

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

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