솔솔
코드 품질을 높이는 리팩토링 여정, 한 달간의 기록 (CodeRabbit 적용) 본문
🤔 문제
혼자 프로젝트를 리팩토링하기에 앞서 고민이 됬던 부분이 하나가 있다.
팀 프로젝트를 혼자서 리팩토링한다는 점이였다.
하지만 이번 리팩토링에서는 혼자서 PR을 올리고, 혼자 Merge를 진행해야 하는 상황이었고,
이 과정에서 코드 품질을 어떻게 유지할 수 있을지 고민이 됬다.
물론 혼자니까 PR을 올리는 과정 없이 바로 Merge해도 되지 않냐고 생각할 수도 있지만
Pull Request 과정 자체가 코드 품질을 점검하고 개선할 기회를 제공하기 때문에,
혼자서 진행하더라도 PR을 올리고 리뷰하는 습관을 유지하는 것이 중요하다고 판단했다.
그래서 어떻게 할까 고민하다 AI 기술을 활용한 코드 리뷰를 도입하기로 결정했다.
그것은 바로 CodeRabbit이다
🟢 CodeRabbit 적용
1. 프로젝트와 CodeRabbit 연동
아래 링크를 통해 CodeRabbit docs를 보면됨.
https://docs.coderabbit.ai/platforms/github-com
프로젝트가 있는 레포지토리가 연결되면 이러한 화면이 나오고
설정을 통해서 다양한 옵션기능들을 활용할 수 있다.
우선 설정을 통해서 리뷰언어를 한국어로 변경했다.
2. CodeRabbit의 코드 변경사항 요약
프로젝트 내에서 기업 규모를 나타내는 EntSize라는 Enum이 존재했다. 이를 다음과 같이 개선했다.
- EntSize → EnterpriseSize로 클래스명 변경 (더 명확한 의미를 전달하기 위해 클래스명을 변경하여, 처음 보는 사람도 쉽게 이해할 수 있도록 개선)
- EnterpriseSize Enum 값에 대한 설명 필드 추가 (각 Enum 값이 의미하는 바를 명확히 전달하기 위해서)
- 기존 EntSize를 사용하던 클래스들도 EnterpriseSize로 일괄 변경
코드 수정 후 Push 하고 Pull Request 올리면, 아래처럼
자동으로 Pull Request 요약이 생성되며,
코드 변경 사항에 대한 요약도 함께 제공된다.
그리고 내가 CodeRabbit을 도입하려고 했던
가장 큰 이유는 바로 코드 리뷰 및 피드백이었다.
실제로 리뷰를 굉장히 꼼꼼하게 해주는 것 같아 나의 만족도는 최상.
클래스명 변경 시 IDE의 자동 변경 기능을 사용해서 변경 할 수 있었지만
@NotEmpty(message="") 안의 문자열까지는 IDE가 자동으로 수정해주지 않는다.
그런데 CodeRabbit은 이런 세세한 부분까지 잡아줘서 상당히 편리한 것 같다.
☁️ 마무리 하며
최근 AI를 활용한 많은 기술들이 등장하고 있는데 이렇게 찾아보면 필요한 상황에 맞춰 적용 할 수 있는 AI기술이 있다는 것도 신기하고 재미있기도 하다.
이제 막 CodeRabbit을 도입 한 단계이지만 앞으로 지속적으로 활용해보면서 혼자서도 코드리뷰를 수행하면서 이를 통해 코드 품질을 더욱 향상을 시키고 싶다.
* 참고 사이트
https://tech.inflab.com/20250303-introduce-coderabbit/
https://tech.inflab.com/20250303-introduce-coderabbit/
안녕하세요. 인프랩의 백엔드 개발자 약풍입니다. 코드 리뷰는 버그를 예방하고, 팀의 코드 품질을 유지시키는 중요한 장치입니다. 많은 개발자들이 서로의 코드에 대해 리뷰하고 피드백하는
tech.inflab.com
'내인생's 기록 > 도전2' 카테고리의 다른 글
코드 품질을 높이는 리팩토링 여정, 한 달간의 기록 (Controller 입력 값 검증) (0) | 2025.04.04 |
---|---|
코드 품질을 높이는 리팩토링 여정, 한 달간의 기록 (Enum 리팩토링) (0) | 2025.04.03 |
코드 품질을 높이는 리팩토링 여정, 한 달간의 기록 (프로젝트 소개) (0) | 2025.04.01 |
코드 품질을 높이는 리팩토링 여정, 한 달간의 기록 (Intro) (2) | 2025.04.01 |