Git Commit Message Convention

기본 구조

제목 (Type: Subject)

본문 (Body)

꼬리말 (Footer) (생략 가능)

 

Type

Tag:(띄어쓰기) Subject

ex)  Feat: "추가 로그인 API "
        Feat: "Add login API"

 

- Tag 종류

 

Tag	Description
Feat	새로운 기능을 추가하는 경우
Fix	버그를 고친 경우
Docs	문서를 수정한 경우
Style	코드 포맷 변경, 세미콜론 누락, 코드 수정이 없는 경우
Refactor	코드 리펙토링
Test	테스트 코드. 리펙토링 테스트 코드를 추가했을 때
Design	CSS 등 사용자가 UI 디자인을 변경했을 때
Rename	파일명(or 폴더명) 을 수정한 경우
Remove	코드(파일) 의 삭제가 있을 때. "Clean", "Eliminate"도 가능

 

Subject

• 제목은 50글자 이내로 작성.
• 첫 글자는 대문자.
• 특수기호는 사용 X.
• 영문으로 작성 시 동사를 가장 앞의 명령어로 작성.
• 현재시제로 작성.

Body

• 본문은 한 줄 당 72자 내로 작성.
• 최대한 상세히 작성.
• 어떻게, 무엇을, 왜 상세히 설명.

Footer

유형: #이슈 번호

ex) Resolves : #123
       Ref: #12

 

- Issue tracker 종류

 

Issue tracker	Description
Fixes	이슈 수정 중
Resolves	이슈 해결
Ref	참고할 이슈
Related to	해당 커밋에 관련된 이슈

 

최종

Feat: "추가 로그인 API"

회원들이 로그인을 할 수 있게 로그인 API 개발

 

Git Emogi

- 이모지도 추가하여 작성하면 좋음.

gitmoji