Skip to content

Git Convention & Code Quality

Hwa Young Yang edited this page Sep 26, 2026 · 4 revisions

브랜치명 규칙

브랜치명 형식

라벨명/Jira번호-기능명

예시

  • chore/FRB-1-deploy
  • feat/FRB-12-social-login
  • fix/FRB-25-image-upload
  • refactor/FRB-31-image-service

Branch Label

Label 설명 예시
feat 새로운 기능 구현 feat/FRB-12-social-login
fix 버그 및 오류 수정 fix/FRB-25-image-upload
refactor 기능 변경 없는 코드 구조 개선 refactor/FRB-31-image-service
chore 설정, 환경 구성 및 기타 작업 chore/FRB-1-deploy
docs 문서작업 docs/FRB-1-docs

Branch Flow

작업 브랜치 → dev → main
  • 기능 개발은 작업 목적에 맞는 별도 브랜치에서 진행합니다.
  • 개발이 완료되면 dev 브랜치를 대상으로 Pull Request를 생성합니다.
  • dev에서 검증된 변경 사항은 Pull Request를 통해 main으로 병합합니다.
  • main, dev 브랜치에는 직접 Push하지 않고 Pull Request를 통해 변경 사항을 반영합니다. --

커밋 메시지 규칙

커밋 메시지 형식

라벨명: 구현 내용

예시

  • chore: 개발 환경 세팅
  • feat: 소셜 로그인 구현
  • fix: 이미지 업로드 오류 수정
  • refactor: 이미지 처리 로직 분리

Commit Label

Label 설명
feat 새로운 기능 구현
fix 버그 및 오류 수정
refactor 기능 변경 없는 코드 리팩토링
chore 설정, 빌드, 개발 환경 등 기타 작업
docs 문서작업

커밋 본문에는 해당 커밋에서 구현하거나 변경한 내용을 구체적으로 작성합니다.

예시

chore: 개발 환경 세팅

- 멀티 모듈 구조 구성
- 공통 설정 추가
- 개발 환경 관련 설정 적용

하나의 커밋에는 가능한 한 하나의 목적을 가진 변경 사항을 포함합니다.

Pull Request & Review Convention

dev, main 브랜치에 병합되기 전에 다른 팀원의 검토를 거쳐야합니다

Merge 조건

Rule 적용 내용
Pull Request dev, main 변경 사항은 PR을 통해 병합
Required Approvals 2명 이상의 Approve 필요
Stale Approval 승인 이후 새로운 Commit이 Push되면 기존 승인 무효화
Conversation Resolution Review Conversation이 모두 Resolve되어야 Merge 가능
Force Push 보호 브랜치의 Force Push 제한
Branch Delete main, dev 브랜치 임의 삭제 제한

Checkstyle

팀원마다 코드 스타일이 달라지는 것을 방지하고 일관된 Java 코드 스타일을 유지하기 위해 Checkstyle을 적용하고있습니다 Naver Java Coding Convention을 기반으로 하며, 멀티 모듈 전체에 동일한 규칙을 적용합니다.

Checkstyle 주요 검사 항목

Category 적용 규칙
File UTF-8, LF 개행, 파일 마지막 개행 필수
Line 최대 120자, 줄 끝 불필요한 공백 금지
Naming 클래스 PascalCase, 메서드/변수 camelCase, 패키지 소문자
Import * Import 금지, Import 순서 및 그룹 통일
Declaration 파일당 Top-Level Class 1개, 변수 개별 선언
Indentation Tab 기반 들여쓰기, Tab Width 4
Braces K&R Style, if / for / while 중괄호 필수
Line Wrapping 콤마, 연산자, Method Chaining 등의 줄바꿈 위치 통일
Whitespace 연산자, 키워드, 콤마, 콜론 등의 공백 규칙 통일
Method 메서드 사이 빈 줄 적용