코드 리뷰 가이드
PR에 있는 답안 코드가 저장소의 기본 브랜치로 병합이 되려면 상호 코드 리뷰를 하고 PR을 승인하는 과정이 필요합니다. 답안 코드가 너무 오랫동안 PR 상태로 방치되는 것을 방지하기 위해서 코드 리뷰 책임제를 도입하였습니다. 본인 PR 바로 전에 올라온 PR은 반드시 지켜야 하는 스터디 참여자의 역할이자 의무입니다! 자신에게 할당된 PR 뿐만 아니라 다른 PR에 대한 코드 리뷰도 당연히 언제나 환영합니다.
[예시]
타인의 코드를 읽고 이해한 후 피드백을 드리기 위해서는 적지 않은 시간과 노력이 들어갑니다. 따라서 피드백이 무시당했다는 느낌을 받으면 감정이 상할 수 있고 리뷰 참여를 떨어뜨려 결과적으로 스터디 문화에 부정적인 영향을 줄 수 있습니다. 코드 작성자는 검토자의 의견을 항상 존중하는 태도를 보여주시기 바랍니다. 이해가 되지 않는 피드백이나 의견이 다른 경우에는 적극적으로 의사소통을 하셔서 적어도 코드 검토자가 시간 낭비를 했다는 느낌이 들지 않도록 조심해주시기 바랍니다.
코드 검토자도 마찬가지로 코드 작성자를 배려하는 자세로 코드 리뷰에 임해주시기 바랍니다. 아무래도 글로만 소통이 이뤄지기 때문에 감정 전달에 한계가 있습니다. 불필요한 오해가 생기지 않도록 어조나 말투에 신경을 써주시면 좋을 것 같습니다.
사실 코드 리뷰에 있어서 특별한 모범 관행은 없습니다. 항상 상대방 입장에서 생각해주시고 상식적인 선에서 서로 배려한다면 좋은 코드 리뷰 문화를 만들어나갈 수 있을 것입니다.
코드 리뷰 관련해서 많은 분들이 오해하시는 부분이 있는데, 코드 리뷰를 통해 반드시 더 나은 해결책을 제시하거나 버그나 실수를 찾아주셔야 하는 것은 아닙니다. 코드를 보고 이해가 잘 안 되는 부분이 있으면 아래 캡쳐처럼 질문을 남기는 것도 매우 좋은 코드 리뷰 방법입니다. 그러면 코드 작성자는 본인의 코드가 얼마나 읽기 쉬운지에 대해서 다시 한 번 고민해볼 수 있습니다. 코딩 면접에서 가독성이 좋은 코드를 짜는 것도 매우 중요한 부분입니다.
참여자 및 코치 간의 소통이 잘 이루어진 모범 사례입니다. 참고하시어 PR에서 자유로이 코멘트 주고받으시길 바랍니다.