WE:A 팀의 코드 리뷰 규칙

  1. 각 팀원은 다른 팀원의 코드를 확인하고 리뷰해줄 의무를 갖는다. (분야 상관 X)

  2. 코드 리뷰의 내용은

    1. 더 나은 코드를 위한 개선점

      → 이 경우에는 대체 할 코드의 예시, 사유 등 구체적으로 명시한다. (필수)

    2. 코드가 이해가지 않을 경우 이에 대한 질의응답

    3. 기타 칭찬 혹은 자유로운 코멘트

    세 가지 중 하나를 자유롭게 선택한다.

  3. 원격 저장소에 feature-branch로 푸쉬한 후 Pull Request를 한 뒤 바로 병합하지 않는다.

  4. 이때 올라온 PR(Pull Request)은 최소 1명 이상의 리뷰어의 승인(Approve) 혹은 코드 리뷰를 받은 후에 업로드 되며 아무리 바쁘더라도 가급적 올라오는 PR에 최대한 리뷰하도록 노력한다. (리뷰 안했다고 비방 또는 비난 및 눈치주는 행동은 절대 금한다.)

  5. 리뷰 하는 것 또한 리뷰 하는 사람의 시간을 할애하는 것이므로 최대한 정중히 부탁하며 부탁을 받은 사람 또한 피치 못할 상황이 아닌 경우라면 최대한 시간을 할애해주어 리뷰에 참여한다.

  6. 리뷰를 올리는 사람은 코드 리뷰를 하는 사람이 보기 쉽도록 주석이나 코드 정리를 깔끔히 하도록 신경 쓴다.

  7. 단순히 코드만 빠르게 작성하여 커밋 푸시 한 것은 식별하기 어려워 코드 리뷰에 들어가는 시간을 늘릴 수 있으므로 서로의 시간을 절약하기 위해 항상 주석을 다는 습관을 들이도록 노력한다.

  8. 리뷰 하는 사람 / 리뷰 받는 사람 모두 **"비판적 사고"**로 리뷰에 임한다.

  9. 리뷰어의 의견이 이해가 가지 않는다면 리뷰어에게 온/오프라인 소통 수단을 사용해 추가적인 설명을 요청한다.

  10. 리뷰어는 리뷰를 요청한 사람의 질문에 답변해줄 의무를 지켜준다.

  11. 코드 리뷰를 받은 개발자는 모든 정보를 종합하여 판단, 해당 PR에 대한 최종 수정 여부는 리뷰를 생성한 개발자의 의견이 가장 중요하다.

  12. 리뷰에 올릴 코드는 가급적 기능단위로 올린다.

    good

    bad

  13. 리뷰에 올릴 코드는 코드의 PR과 함께 테스트 결과실행 사진 등을 스크린샷 또는 시각적으로 확인 가능한 결과와 함께 올리도록 노력한다.

ex) 로그인 기능 업로드 시, 로그인이 잘되는 것을 촬영한 영상 or 스크린샷 등

  1. 시각 자료의 양식은 제한하지 않으며 링크, 임베드, 사진, 동영상 등 리뷰하는 사람이 볼 수 있는 모든 양식의 자료를 사용한다.

참고하면 좋을 영상

https://www.youtube.com/watch?v=VaaRvs8YU1M