Git 컨벤션

목차

• Commit Convention
  • Commit Message
  • Commit Title
  • Commit Unit
• Pull Request
  • Pull Request Title
  • Pull Request Contents
• Branch
  • Branch Role
  • Git flow

Commit Convention

Commit Message

• feat: 기능 추가 및 수정
• design: 레이아웃 추가 및 수정
• fix: 버그 수정
• test: 테스트 코드 추가 및 수정
• setting: 환경 설정
• docs: 문서 추가 및 수정
• refactor: 코드 리팩토링
• style: 주석, 프리티어 등 기능의 영향없이 코드의 모양새만 바뀌는 경우
• ci: CI 관련 변경
• perform 성능 변화를 목적으로 코드 추가 및 수정

Commit Title

커밋 타입 [커밋 범위]: 커밋 메세지 제목 (#이슈번호)

- 좋은 예시) feat [FE] : 깃허브 로그인 버튼 컴포넌트 구현 (#13)

- 나쁜 예시) feat: 로그인 구현

• 커밋 타입 : 소문자 영단어로 작성
• 커밋 범위 : FE (클라이언트 관련 작업), BE (서버 관련 작업), DO (DevOps 관련 작업) 중 관련된 작업으로 작성
• 커밋 메세지 제목 : 명령형으로 작성, 마침표로 끝나지 않음
• 이슈번호 : 커밋과 관련된 이슈 번호 작성

Commit Unit

• 커밋 메시지를 기준으로 작성
• 하나의 커밋에는 하나의 작업단위만 작업
• 한 커밋이 너무 많은 파일을 수정하는 것을 지양

Pull Request

Pull Request Title

태스크: Pull Request 제목

• 태스크: 하나의 이슈로 지정한 업무
• 제목 : 태스크 이름

Pull Request Contents

# 요약
<!--해당 PR에 대한 설명 혹은 이미지등을 넣어주세요. -->

# 연관 이슈
(fix #일이삼)
<!--이슈 번호를 적어주세요(예시: fix #123). -->

# Pull Request 체크리스트

## TODO

- [ ] 최종 결과물을 확인했는가?
- [ ] 의미 있는 커밋 메시지를 작성했는가?
  - 좋은 예시) feat [FE] : 깃허브 로그인 버튼 컴포넌트 구현 (#13)
  - 나쁜 예시) feat: 로그인 구현

Branch

Branch Role

• main : 기준이 되는 브랜치로, 배포 서버의 버전과 일치하도록 유지한다.
• dev: 다음 출시 버전을 개발하는 브랜치
• feature: 단위 기능을 개발하는 브랜치. 완료되면 develop 브랜치에 merge(양식: #이슈번호-기능명)
• hotfix: 출시 버전에서 발생한 버그를 긴급 수정하는 브랜치(양식: #이슈번호-기능명)
• release: v-버전명 형식으로 main 브랜치에서 분기한다.

Git Flow

• main 브랜치로부터 dev 브랜치 분기
• feature 브랜치에서 기능개발 후 dev 브랜치에 Pull Request 작성
• dev 브랜치는 개발서버에서 테스트
• 기능 구현이 있는 경우 dev 브랜치에서 feature 브랜치 분기
• 배포 후 dev 브랜치에서 release 브랜치 분기