씨앤에이아이 개발문화|코드리뷰 방법과 필수 내용

씨앤에이아이 소식

도전과 끊임없는 연구를 하는 CNAI의 소식을 전합니다.
보도자료와 새로운 소식을 만나보세요.

씨앤에이아이 개발문화 - 코드리뷰란? 코드리뷰 방법과 필수 내용 [2022-05-04]#1 - DX플랫폼 개발 2팀 개발 이야기

코드리뷰란? 코드 검토(code review)는 코드를 개발자가 작성하고, 다른 개발자 한명 또는 여러명이 정해진 방법을 통해 검토하고, 피드백을 주는 과정을 말한다. 네이버, 카카오, 많은 스타트업에서 코드리뷰를 진행하는데, 씨앤에이아이 DX플랫폼 사업부 개발 2팀은 google, w3school 등 에서 reference 하고 (google 코드리뷰 가이드)를 활용해서 리뷰 요청과 검토를 완료(Approve)하는 방식으로 코드 리뷰를 진행한다. 코드리뷰 가이드 설계 - 코드가 잘 설계 되어있으며, 시스템에 적합한가? 기능 - 코드가 작성자가 의도한 대로 동작하는가? - 사용자에게 좋은 방식으로 작동하는가? 복잡성 - 더 간단한 코드로 만들 수 있는가? - 다른 개발자가 나중에 이 코드를 접했을 때 이 코드를 쉽게 이해하고 사용할 수 있는가? 테스트 - 코드에 정확하고 잘 설계된 자동화 테스트가 있는가? 네이밍 - 개발자가 변수, 클래스, 메소드 등에 대해 명확한 이름을 선택했는가? 주석 - 주석이 명확하고 유용한가? 스타일 - 코드가 스타일 가이드(코딩 컨벤션)을 따르고 있는가? 문서 - 개발자가 관련 문서도 업데이트했나? [참고1] 구글 리뷰가이드 https://google.github.io/eng-pra ctices/ [참고2] 코드 리뷰의 기준 https://google.github.io/eng-practices/review/reviewer/standard.html 코드리뷰 방법 1 피처 브랜치에서 작업 후 Pull Request 2 디벨롭 머지 시 리뷰 요청 3 개발팀 개발자 전원이 동의했을 때 디벨롭에 머지 4 형상관리 체계 리뷰 필수내용 1 코드 검토는 1시간 이내 끝낼 분량으로 한다 2 코드는 200라인 이상을 한 번에 검토하지 않는다
이전글	\| 씨앤에이아이 개발문화 - 코드리뷰 중요성과 장점,예외처리 검토
다음글	\| 쿠캣 고객센터 - 씨앤에이아이 '클라우드 컨택센터 솔루션" 도입