코드 리뷰의 코멘트에 태그를 사용하여 심리적 안전성 올리기

※ 일본의 한 블로그 글을 번역한 포스트입니다. 오역 및 의역, 직역이 있을 수 있으며 틀린 내용은 지적해주시면 감사하겠습니다.

 

 

GitHub의 Pull Request 리뷰에 대해서

---

 코드 리뷰에서 먼저 제일 중요하게 여기는 것은 "요구를 만족하는 동작이 구성되어 있는가"이다. 그리고 다음은 이러한 점을 중시하여 리뷰하고 있다.

• 외부 서비스의 특수한 동작이나 세큐리티등을 고려하고 있는가?
• 버그가 발생했을 때에 검지할 수 있도록 되어 있는가?
• 향후에 수정하기 힘들게 되어 있지는 않은가?
• N+1문제등 퍼포먼스 문제는 없는가?

 그리고 이러한 기준으로 코멘트를 쓸 때에 다음과 같이 태그를 나눠서 작성하고 있다.

• must : 절대적으로 고쳤으면 할 때, 강한 지적이므로 상대의 프라이드에 상처를 주지 않도록 주의하면서 코멘트를 작성해야한다.
• imo : "나라면 이렇게 할 것같다", "나는 이렇게 생각한다"라는 뉘앙스를 전달하고 싶을 때
• nits : 메소드명의 수정같은 가벼운 수정이나 적은 부분을 수정해줬으면 할 때
• q : 질문, 불명확한 부분이나 자신이 잘 모르겠는 부분에 대해 물어볼 때

 

 

심리적 안정성

---

 심리적 안전성에 대해서는 이전에 포스팅한 적이 있기 때문에 "우리는 심리적 안전성을 오해하고 있을지도 모른다"를 참고해주길 바란다.

 

 

코멘트 태그로 심리적 안전성을 올리기

---

 자 심리적 안정성을 담보하는 중요 항목으로써 코멘트 태그가 어떻게 작용하는지 자세히 설명하도록 하겠다.

 

1. 발언을 할 수 있는 환경을 만든다.

 코멘트 태그를 달면 "나는 이러한 마음으로 코멘트를 작성하고 있다"라는 의지를 표명할 수 있다. 예를 들어 "nits" 태그를 붙이는 것으로 코딩 규약에 따른 코드 (적당한 메소드명, 코멘트의 추가)를 지적하는 허들을 낮춰 건설적인 의견 교환을 할 수 있다.

 

2. 자신이 실수할 가능성을 인정할 수 있다.

 논의가 진행되어 리뷰어 자신의 인식이 어긋남을 깨닫는 경우도 있다. 스스로의 실수를 두려워 원래 지적해야한 부분을 놓쳐 버리는 자체를 방지할 수 있다.

 

3. 호기심을 갖게 된다.

 반론이 두려워 무관심한 리뷰가 되어버리는 경우가 자주 있는데 [imo]나 [q] 태그를 사용하여 코드의 백 그라운드를 들으므로써 사양에 대해 이해할 수 있고 서로의 생각에 대해 이해할 수 있는 장이 된다.

---

참고자료

https://zenn.dev/lincwell_inc/articles/comment_tags_to_ensure_psychological_safety