
백엔드
스포카의 백엔드팀에서 코딩 컨벤션을 관리하는 방법
두줄요약
코딩 컨벤션을 문서, Lint, 코드 리뷰, SonarQube, Konsist로 나눠 관리한 사례를 소개했습니다. 자동화와 리뷰를 조합해 스타일과 구조 규칙을 함께 지키는 방법을 설명했습니다.
핵심 내용
- 스포카 백엔드팀의 코딩 컨벤션 관리 경험을 문서, Lint, 코드 리뷰, SonarQube, Konsist 순서로 정리
- README 문서만으로 관리할 때의 문서 노후화 문제와 실제 코드 불일치 문제를 보완하기 위해 자동화 도구를 도입
- ktlint로 스타일 규칙을 자동화하고, 코드 리뷰로 구조와 도메인 요구사항을 점검
- SonarQube로 중복, 복잡도, 보안 취약점 같은 더 넓은 품질 이슈를 확인하고, Konsist로 레이어 의존성 같은 구조적 규칙을 테스트로 검증
적용해볼 점
- 스타일 규칙은 Lint와 pre-commit hook으로 자동화
- 구조적 규칙은 테스트 기반 도구로 명시적으로 검증
- 코드 리뷰는 사소한 규칙보다 설계와 도메인 검토에 집중
