코드 리뷰 컨벤션

[dahye1013]

코드리뷰 컨벤션

P1

• 꼭 반영해주세요.

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

P2

• 적극적으로 고려해주세요.
• 작성자는 P2에 대해 수용하거나 만약 수용할 수 없는 상황이라면 적합한 의견을 들어 토론할 것을 권장해요. (보통 P1, P2 의견이 있을 때엔 Request Change와 함께 사용되는 것 같아요.)

P3

• 웬만하면 반영해주세요.
  • 작성자는 P3에 대해 수용하거나 만약 수용할 수 없는 상황이라면 반영할 수 없는 이유를 들어 설명하거나 다음에 반영할 계획을 명시적으로(JIRA 티켓 등으로) 표현할 것을 권장해요. (중요하지 않다 생각되면 편하게 이유를 들고 거절해도 돼요)

P4

• 반영해도 좋고 넘어가도 좋아요.
  • 작성자는 P4에 대해서는 아무런 의견을 달지 않고 무시해도 괜찮아요. 해당 의견을 반영하는 게 좋을지 고민해 보는 정도면 충분해요.

P5

• 그냥 사소한 의견이에요.
  • 작성자는 P5에 대해 아무런 의견을 달지 않고 무시해도 돼요.

---

기능 구현시기에는 규칙이나 컨벤션이 저희의 생산성을 떨어트리면 악수라고 판단하여 규칙을 세우지 않고 작업했는데,
현재 작업물이 기능 구현으로는 안정적인 시기라고 생각해요 :)
오히려 작업물을 안정적으로 가져가기 위해 서로의 오류를 검토해주는게 더 중요한 시기라는 생각이 들기도 하구요!
이제는 코드 리뷰도 서로 적극적으로 하기로 했으니 리뷰 컨밴션을 가져보는 건 어떨까요?
전에 동근님 공유해주셨던 코드 컨벤션 내용을 가져왔어요!
확인하고 의견 달아주세요 ☺️

@codeisneverodd @ljw0096

---

참고 자료

뱅크 샐러드 코드 개발 문화
https://blog.banksalad.com/tech/banksalad-code-review-culture/