코드 리뷰 가이드
스터디 저장소에 답안 코드를 병합하려면, 상호 코드 리뷰 및 PR 승인 절차를 반드시 거쳐야 합니다. 제출해주신 답안 코드가 장시간 PR 상태로 방치되는 것을 막기 위해 코드 리뷰 책임제를 운영하고 있습니다.
📌 내 PR 바로 전에 올라온 PR을 리뷰하는 것은 모든 참여자의 의무입니다.
물론 자신에게 배정되지 않은 PR이라도, 여유가 된다면 자유롭게 코드 리뷰에 참여해 주세요!
[예시]
위 리뷰 규칙은 사용하는 프로그래밍 언어와 무관하게 동일하게 적용됩니다. 언어별로 구분을 두면 비인기 언어 사용자들의 코드 리뷰 참여가 어려워질 수 있기 때문입니다. 이미 풀어보신 문제이니 언어 문법이 익숙하지 않더라도 흐름은 대강 파악하실 수 있을 것입니다. 만약 그렇지 않다면 이는 리뷰어의 잘못이 아니라 코드 작성자가 개선할 부분일 확률이 크니 이해 안 되시는 부분에 대해서 부연 설명을 요청하시거나 가독성에 대한 솔직한 피드백을 주시기 바랍니다.
Tip
실무 면접에서도 면접관과 지원자의 주 사용 언어가 다를 수 있습니다. 어떤 언어든 읽기 쉬운 코드를 작성하는 것은 소프트웨어 개발자로서 중요한 역량입니다.
필요하다면 AI 도구를 활용해도 좋습니다. AI가 이종 언어 간 코드 변환도 꽤 잘해주니까요. 😉 프로그래밍 언어가 결코 코드 리뷰에 장벽이 되지는 않을 것입니다.
타인의 코드를 읽고 이해한 후 피드백을 드리기 위해서는 적지 않은 시간과 노력이 들어갑니다. 따라서 피드백이 무시당했다는 느낌을 받으면 감정이 상할 수 있고 리뷰 참여를 떨어뜨려 결과적으로 스터디 문화에 부정적인 영향을 줄 수 있습니다. 코드 작성자는 검토자의 의견을 항상 존중하는 태도를 보여주시기 바랍니다. 이해가 되지 않는 피드백이나 의견이 다른 경우에는 적극적으로 의사소통을 하셔서 적어도 코드 검토자가 시간 낭비를 했다는 느낌이 들지 않도록 조심해주시기 바랍니다.
코드 검토자도 마찬가지로 코드 작성자를 배려하는 자세로 코드 리뷰에 임해주시기 바랍니다. 아무래도 글로만 소통이 이뤄지기 때문에 감정 전달에 한계가 있습니다. 불필요한 오해가 생기지 않도록 어조나 말투에 신경을 써주시면 좋을 것 같습니다.
사실 코드 리뷰에 있어서 특별한 모범 관행은 없습니다. 항상 상대방 입장에서 생각해주시고 상식적인 선에서 서로 배려한다면 좋은 코드 리뷰 문화를 만들어나갈 수 있을 것입니다.
코드 리뷰 관련해서 많은 분들이 오해하시는 부분이 있는데, 코드 리뷰를 통해 반드시 더 나은 해결책을 제시하거나 버그나 실수를 찾아주셔야 하는 것은 아닙니다. 코드를 보고 이해가 잘 안 되는 부분이 있으면 아래 캡쳐처럼 질문을 남기는 것도 매우 좋은 코드 리뷰 방법입니다. 그러면 코드 작성자는 본인의 코드가 얼마나 읽기 쉬운지에 대해서 다시 한 번 고민해볼 수 있습니다. 코딩 면접에서 가독성이 좋은 코드를 짜는 것도 매우 중요한 부분입니다.
참여자 및 코치 간의 소통이 잘 이루어진 모범 사례입니다. 참고하시어 PR에서 자유로이 코멘트 주고받으시길 바랍니다.