코드 리뷰 잘하는 법

좋은 코드 리뷰는 어떻게 할까요? 코드 리뷰에 관한 블로그 글이 있어 내용 정리해서 간단한 생각과 함께 올려봅니다. 1️⃣ 오프라인으로 논의해도 될 건 오프라인으로 하기 상대방의 코드에 많은 피드백을 남겨야 한다면, 단순히 수십 개가 넘는 피드백을 코멘트에 남기지 말고 검토한 부분을 대화를 통해 작성자와 함께 확인하는 게 훨씬 효과있다고 합니다. 개인적으로 공감하고 좋은 방법이라고 생각하긴 하지만, 길게 보면 좋은 방법은 아닌듯 합니다. 예를들어, 한 명의 엔지니어가 5명이 넘는 코드 작성자를 한 명씩 만나서 한 시간씩 코드 검토한 점을 의논할 수 없습니다. 일대일 면담 외 가능한 방법: 1. 자주하는 코드 작성 관련 피드백은 템플렛화해서 동료에게 가르치기 2. 다른 사람에게 위임하기 (그 사람에게는 롤모델로 성장할 기회가 주어진다) 3. 웬만한 코드는 자동으로 검토해주는 개발 도구 이용하기 2️⃣ 리뷰하지 말아야 할 코드는 참견하지 말기 내가 잘모르는 코드베이스관련 코드 변경을 검토해달라고 요청했다면 거절할 줄도 알아야 합니다. 양날의 검과 같은 조언인데, 무조건 모른다고 거절하면 떠넘기기만 하게 됩니다. 모른다고 무조건 거절하는 게 아니라, 좀 더 디테일하게 설명하자면 중요한 코드를 검토해야 할 때, 최대한 검토해 줄 수 있는 부분은 해주되, 솔직하게 모르는 부분은 모른다고 하고 기대치를 설정하는 게 좋을 것 같습니다. 그래야 상대방이 기대치를 잘 이해하고 적합한 검토자를 다시 찾거나 또는 다른 조치를 취할 수 있을 것 같습니다. 3️⃣ 비판할 점은 그냥 비판만 하지 말고 정당한 이유도 같이 공유하기 예를 들어 "여기에는 이렇게 코드 작성하세요"라고만 말하지 말고 정당한 이유도 같이 공유하는 게 좋다고 합니다. 크게 공감하는 부분이에요. 단순하게 바꾸라고 말하면 상대방은 '왜' 그래야 하는지 모르고, 같은 실수를 반복할 수 있습니다. 반면에 이유를 확실하게 알면 같은 실수를 반복할 확률이 줄어들어요. 스택오버플로우나 정식 도큐먼트 또는 블로그 글 링크를 첨부하거나, 시간 있다면 자세하게 설명해 주세요. 그렇다고 모든 코멘트를 정당화하지 않아도 됩니다. 때에 따라서 코드 가독성을 높이거나, 오타 체크 또는 사소한 점은 간단하게 알려주기만 해도 괜찮아요. 4️⃣ 꼼꼼하게 살펴보기 원문에서 '코드 검토'할 때 어떤 점을 꼼꼼하게 봐야 하는지 자세하게 적은 PDF를 공유했습니다. 관심 있으신 분들은 확인 해보세요. 5️⃣ 다른 사람 코드 리뷰 살펴보기 시간 있다면 내 것만 보지 말고 다른 엔지니어가 어떻게 코드 리뷰하는지 살펴보세요. 마지막은 원문에 언급되지 않았지만, 개인적으로 유용했던 점입니다. 코드 검토할 줄 모르던 주니어 시절이나 코드 검토 퀄리티를 높이고 싶을 때 팀 또는 조직 내에 코드를 잘 검토하는 선임의 리뷰를 살펴보았습니다. 내가 검토해야 할 코드가 아니어도 다른 사람들이 검토하는 것을 보며 많은 것을 배울 수 있었습니다. 🪴 함께 읽으면 좋은 글: 코딩 외에 개발자에게 절대적으로 필요한 스킬 https://careerly.co.kr/comments/78115 신입, 경력직 회사 생활과 자기 계발에 필요한 것 https://careerly.co.kr/comments/77994 2월 멘토링 취업, 이력서 작성 관련 큐앤에이 모음 https://careerly.co.kr/comments/78748

Creating a Code Review Culture, Part 2: Code Reviewers - Squarespace / Engineering

Squarespace / Engineering

Creating a Code Review Culture, Part 2: Code Reviewers - Squarespace / Engineering

다음 내용이 궁금하다면?

또는

이미 회원이신가요?

2023년 4월 18일 오전 5:01

 • 

저장 68조회 5,146

댓글 0

    함께 읽은 게시물

    매일의 루틴을 갖는다는 것

    ... 더 보기

    루틴이 있었던 시절

    K리그 프로그래머

    루틴이 있었던 시절

     • 

    댓글 1 • 저장 16 • 조회 4,581


    [🇺🇸미국과 캐나다 근무 환경 차이점?🇨🇦]

    미국과 캐나다 대기업의 근무 환경에 약간의 차이점이 있다는 걸 느꼈습니다. ✨첫 번째: 업무 스트레스 캐나다에서 개발자로 일했었을 때 업무 스트레스가 훨씬 적었습니다. 그 이유는 캐나다 정서 특성상 "laid back", 즉 좀 여유로움이 묻어 있어서 그런지 모두가 5시만 되면 칼퇴근했었습니다. 미국은 영주권 절차가 최소 2년 최대 10년 이상 걸립니다. 결혼 영주권은 빠르다고 생각하나, 요즘 결혼 영주권도 최소 2년 걸립니다. 반면에 캐나다의 경우 6개월 만에 영주권 수령했었습니다. 영주권이 주는 건 "freedom". 언제든 맡은 업무가 적성에 맞지 않거나 높은 연봉을 받으려고 다른 회사로 이직할 수 있기 때문에 마음이 편했습니다. ✨두 번째: 연차, 공휴일 차이점 미국과 캐나다를 비교했을 때 캐나다는 매 달 공휴일이 최소 하루 정도 있었습니다. 회사마다 또는 주마다 천차만별이나, 미국은 최소 6일 정도 있는 반면 캐나다는 적어도 1년에 12일 정도 있었었습니다. 한 달에 한 번씩 주말이 3일인 주가 있었기 때문에 여행을 자주 다닐 수 있었습니다. ✨세 번째: 팀 다양성 미국의 경우 취업 비자와 영주권 ... 더 보기

    < 좋은 관계를 위한 최소한의 예의, ‘거리 두기’ >

    1. 살다보면 나를 끔찍이 싫어하는 사람이 한둘은 나오게 마련이다.

    ... 더 보기

    테드(TED) 강의장에 황소가 등장했다. <생각의 공유> 저자 리오르 조레프는 청중에게 황소 무게를 예측해 보라고 제안한다. 그러자 140㎏에서 3t까지 다양한 오답이 쏟아졌다.

    ... 더 보기

    왜 공동체에 집단 지성이 필요한가?

    기호일보 - 아침을 여는 신문

    왜 공동체에 집단 지성이 필요한가?


    📣 아미고(Ameego) 전화 걸어주기 출시!! (Beta)

    ... 더 보기

     • 

    저장 1 • 조회 728