[코드리뷰] Qodo를 이용한 Github 코드리뷰 구현

1. 개요

멘토링을 진행한 이후에 팀원들과 코드리뷰를 진행하는 것이 좋지만 누굴 알려줄 만큼의 지식이 있지도 않고 프로젝트 기간도 긴 편이 아니라서 AI를 이용한 코드리뷰를 이용해보기로 했고, 여러 코드리뷰를 찾던 중 "Qodo"라는 코드리뷰를 사용해보기로 헀다.

 

2. 코드리뷰란?

• 소프트웨어를 실행하지 않고 사람이 직접 검토하는 과정을 통해 잠재적 결함을 찾아내고 개선해 나가면서
  전반적인 소프트웨어의 품질을 높이고자 하는 활동
• 즉, 한 개발자가 코드를 작성하면 다른 개발자들이 정해진 방법으로 피드백을 주고받는 과정을 의미한다.
• Code을 보고 서로 소통하면서 서로 배움을 얻는 활동
• 장점
  • 코드 품질 향상
  • 지식 공유와 동반 성장
  • 프로젝트 안정성 및 일관성 확보
  • 건강한 개발 문화와 협업

 

3. 코드리뷰에서 지켜야할 가이드라인

코드리뷰의 특징
코드 가독성	코드는 명확하게 읽고 이해할 수 있어야한다. 팀의 가이드라인에 따라서 적절한 들여쓰기를 사용해야 하며, 변수와 함수의 이름을 적절하게 지정해야한다.
코드의 신뢰성	입력값이 무엇이든 프로그램 충돌없이 제대로 처리해야 함을 의미한다.  코드에는 이해하기 쉽도록 적절한 주석이 달려 있어야 한다.
아키텍처 및 데이터 흐름	모든 코드가 적절한 설계 지침과 원칙을 따라야한다. Ex) 파일 관 리가 용이하도록 적절한 패키지 아래에 배치해야 한다.
중복 없음	주석 처리된 코드, 사용되지 않는 코드, 중복된 코드가 없어야 한다.
완전성	작성한 코드가 목적/기능을 완벽하게 수행해야한다.
최적화	코드 속도를 높이거나 메모리 사용량을 크게 줄일 수 있는 최적화 가능성이 있는지 탐색

 

3. Qodo를 이용한 코드리뷰 연결

Qodo로 Github에 코드 리뷰를 연결하는 것은 아주 간단한 일이다

https://www.qodo.ai/

(1) 먼저 QoDo 공식 홈페이지로 이동해서 "Get Startd"를 선택한다.

(2) Qodo를 로그인하면 개인 홈에서 "Connect repositories"를 클릭

 

(3) Github Cloud에 연결한다.

 

(4) 이제 여기서 원하는 곳의 Repository를 선택하면 모든 준비가 끝나고 자동으로 main 브랜치에 PR할 때마다 코드리뷰가 생성된다.