Git 컨벤션

목차

1. Commit Convention
2. PR Convention
3. Branch Convention
4. Commit Unit

Commit Convention

Commit 메시지

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

Commit Title

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

ex) feat [FE] : 깃허브 로그인 버튼 컴포넌트 구현 (#13)

• 커밋 타입 은 소문자로 작성한다.
• 커밋 범위 에는 FE (클라이언트 관련 작업), BE (서버 관련 작업), DO (DevOps 관련 작업) 중 관련된 작업으로 작성한다.
• 커밋 메세지 제목 은
• 이슈번호 에는 커밋과 관련된 이슈 번호를 작성한다.

Commit Unit

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

Pull Request

태스크: 태스크는 하나의 이슈로 지정한 업무를 말한다.

제목 : 태스크 이름 내용 : 해당 PR에서 어떤 작업을 수행했는지 정리

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

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

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

Branch