Git convention

마동찬·2023년 4월 25일
0
태그이름설명
Feat새로운 기능을 추가할 경우
Fix버그를 고친 경우
DesignCSS 등 사용자 UI 디자인 변경
!BREAKING CHANGE커다란 API 변경의 경우
!HOTFIX급하게 치명적인 버그를 고쳐야하는 경우
Style코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우
Refactor프로덕션 코드 리팩토링
Comment필요한 주석 추가 및 변경
Docs문서를 수정한 경우
Test테스트 추가, 테스트 리팩토링(프로덕션 코드 변경 X)
Chore빌드 태스트 업데이트, 패키지 매니저를 설정하는 경우(프로덕션 코드 변경 X)
Rename파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
Remove파일을 삭제하는 작업만 수행한 경우

제목작성

제목은 코드 변경 사항에 대한 짧은 요약을 나타냅니다. 제목은 다음의 규칙을 지킵니다.

  • << 태그 >> : << 요약 메시지 >> 형식으로 작성합니다.
  • 제목의 처음은 동사 원형으로 시작합니다.
  • 총 글자 수는 50자 이내로 합니다.
  • 문장의 끝에 특수문자는 삽입하지 않습니다. 예) ., !, ?

영어로 작성하는 경우 다음의 규칙을 따릅니다.

  • 첫 글자는 대문자로 작성합니다.
  • "Fix", "Add", "Change"의 명령어로 시작합니다.

꼬릿말은 아래에 작성

  • 꼬리말은 반드시 작성할 필요는 없습니다.
  • << 유형 >>: #<< 이슈 번호 >> 형식으로 작성합니다.
  • 여러 개의 이슈 번호를 적을 때는 쉼표로 구분합니다.
  • 이슈 트래커 유형은 다음 중 하나를 사용합니다.
    • Fixes: 이슈 수정중 (아직 해결되지 않은 경우)
    • Resolves: 이슈를 해결했을 때 사용
    • Ref: 참고할 이슈가 있을 때 사용
    • Related to: 해당 커밋에 관련된 이슈번호 (아직 해결되지 않은 경우)

커밋 메세지 예시

Feat: 사용자 인증 기능 구현

- OAuth 연동
- 회원가입과 로그인 로직 구현
- 로그인, 회원가입 폼 컴포넌트 구현

Fixes: #13
Resolves: #11, #12
Ref: #10
Related to: # 14
profile
새내기개발자 성장기록

0개의 댓글