커밋 규칙
태그: 커밋 메세지
커밋 메시지 Body에는 더 자세한 내용을 적어주세요
# 제목과 본문은 한국어로 한다
# 제목과 분문을 한 줄 띄워 분리한다
# 본문에는 "어떻게" 보다는 "무엇을", "왜" 에 대해 설명한다
# 제목은 문장이 아닌 단어로 끝맺음한다 (ex: ~ 기능 구현)
# 제목 끝에 마침표(.) 금지
태그 |
설명 |
feat: |
새로운 기능을 추가한 경우 |
fix: |
버그를 고친 경우 |
style: |
기능과 관련된 코드 변경 없이 스타일이 변경된 경우, 세미콜론 누락, 오타 수정 |
refactor: |
기능과 관련된 코드 수정, 타입 또는 변수명 변경 |
docs: |
문서 수정한 경우 (ex 리드미) |
test: |
테스트 추가, 테스트 리팩토링 |
setting: |
기본 세팅 및 빌드 관련 업데이트 |
remove: |
파일을 삭제하는 작업만 수행한 경우 |
deploy: |
배포 관련 작업을 진행한 경우 |
design: |
css관련 수정을 한 경우 |
# ⭕️ Good Examples
feat: 회원가입 이메일 인증 기능 구현
새로운 회원가입 프로세스에 이메일 인증 단계 추가
- 사용자 경험 향상을 위해 이메일 인증 도입
- 스팸 계정 생성 방지를 위한 보안 강화
- 인증 메일 템플릿 추가
- 이메일 인증 상태 저장을 위한 DB 컬럼 추가
fix: 주문 취소 시 재고 미반영 버그 수정
주문 취소 프로세스에서 재고 업데이트 로직 누락 문제 해결
- 취소된 상품의 재고가 자동으로 복구되지 않는 이슈 발견
- 주문 취소 시 재고 자동 복구 로직 추가
- 기존 미반영 주문건 일괄 수정을 위한 배치 작업 추가
refactor: 상품 검색 로직 성능 개선
상품 검색 속도 향상을 위한 로직 최적화
- 기존 LIKE 검색을 ElasticSearch로 전환
- 검색 결과 캐싱 도입으로 응답 시간 50% 단축
- 불필요한 조인 쿼리 제거
docs: API 문서 가이드라인 업데이트
REST API 문서 작성 기준 개선
- 신규 입사자들의 빠른 적응을 위한 예시 추가
- API 명세 작성 포맷 통일
- Swagger 활용 방법 가이드 추가
test: 장바구니 기능 테스트 코드 추가
장바구니 관련 기능의 안정성 확보를 위한 테스트 추가
- 상품 추가/삭제 테스트 케이스 작성
- 수량 변경 시나리오 테스트 추가
- 장바구니 금액 계산 로직 테스트 구현
# ❌ Bad Examples - 이렇게 하지 마세요
feat: 이메일 인증 추가. # 마침표 사용하지 않음
fix: 버그 수정했습니다 # 문장으로 끝맺음하지 않음
refactor: 검색 로직 개선
LIKE 검색을 ElasticSearch로 변경 # 제목과 본문 사이 줄바꿈 없음
docs: API 문서 수정함 # 구체적인 내용 없음
test: 테스트 코드 추가했음
테스트를 이렇게 저렇게 수정했습니다 # "어떻게"가 아닌 "무엇을", "왜"를 설명해야 함
브랜치 규칙
브랜치 |
역할 |
main |
배포를 위한 브랜치 |
feat/#이슈번호 ex) feat/#1 |
작업을 위한 브랜치 - 새로운 기능 개발 |
dev-front |
프론트 개발 브랜치 |
dev-back |
백 개발 브랜치 |
- 이슈 생성 후 생기는 # 번호에 따라 각 dev 브렌치에 fe-feat#번호 생성 후 작업
테스트 브랜치는 없나요?
# 브랜치 구조
main
│
├── release
│
├── hotfix
│
├── dev-front
│ ├── fe-feat#23
│ ├── fe-feat#25
│ └── fe-feat#28
│
└── dev-back
├── be-feat#24
├── be-feat#26
└── be-feat#29
- 릴리즈 브랜치도 필요한데..~
- GitFlow 전략