구글은 👨‍💻코드 리뷰👩‍💻 이렇게 한다

본 게시글은 SW정글 수업, 카이스트 류석영 교수님의 'Code Review'강의를 바탕으로 작성하였습니다.

1 👨‍💻코드리뷰👩‍💻란 뭘까요?

• 쉽게 말해, 지정된 3명 이상의 동료로부터 본인이 작성한 코드를 피드백 받는 과정을 말합니다. 소프트웨어 개발 흐름에서 꼭 필요한 단계로 부상하고 있습니다. 구글의 경우, 모든 코드 변경을 레파지토리에 업로드 하기 전, 관련된 코드 리뷰어를 선정하여 변경을 검토하게 합니다. 자세한 코드 리뷰 절차는 아래 설명해드릴게요!

• ⛔이건 코드 리뷰가 아니에요!⛔ (소프트웨어 설계, 프로덕트 기능 회의 등)

2 코드리뷰 언제, 어떻게 할까요?👨‍🏫👨‍🏫

• 코드리뷰는 코드 작성자가 Commit하기 직전에 시행합니다.
  STEP1) 코드변화리스트(CL)를 작성
  STEP2) 동료에게 코드변화리스트를 전송
  STEP3) 지정된 동료가 코멘트를 남김
  STEP4) 스텝2~3를 반복하며, 코드 작성자가 리뷰어들에게 LGTM(Looks good to me)을 받을 때 까지 리뷰를 교환
  STEP5) 모든 리뷰어들이 LGTM을 외치면, 레파지토리에 커밋
  
• 왜 LGTM(Looks Good To Me)일까요~?
  -> 코드 소유자와 리뷰어 간 의견 교환을 통해 작성된 코드에 대해 리뷰어가 더 이상 피드백 할 것이 없다고 판단되면, '본인이 보기에 좋아 보인다'는 의미로 LGTM을 보내준다고 합니다.

3 코드리뷰 왜 해야할까요?🤔🤔

• 코드는 작성자를 위한 게 아닙니다. 코드 리뷰는 코드를 읽는 사람이 읽을 수 있게 코드를 만드는 과정으로 나의 코드 리스트를 이해하기 쉽게 만드는 과정입니다.
• 나의 동료가 남긴 코멘트를 통해 tip과 lesson을 받을 수 있음.
• 개발은 개인 단위로 진행되는 게 아닌, 팀 단위 진행이기 때문에 코드 리뷰를 통해 팀이 공통된 코딩 스타일을 공유할 수 있게 됩니다.
• Code Decision에 대한 개발 역사가 보관되며, 이를 통해 새로온 개발자가 committed log와 comment를 보고 코드의 구조와 결정 사항을 이해할 수 있습니다
  

4 코드리뷰 이건 조심해주세요!

• 거칠고 무례한 의견은 자제해주세요
• 리뷰가 늦어질수록 개발 기간이 딜레이 됩니다
• 코드 리뷰는 시간이 많이 걸립니다
• 잘못된 CL을 리뷰하느라 숙련된 개발자 시간을 허비할 수 있습니다
• 어느 정도 숙련된 개발자가 필요합니다

5 구글 파이썬 가이드

-> 구글은 C++, C#, Java, Python 등 다양한 언어의 가이드를 작성하고 있습니다. 아래 링크를 통해 언어별 가이드를 확인하실 수 있습니다.

구글 스타일 가이드
구글 파이썬 가이드