Git - 커밋 컨밴션

이번 나누기 팀 프로젝트를 진행하면서 깃에 커밋할 때 일관성과 가독성을 높이기 위해서

깃 커밋 컨밴션을 적용하여 커밋을 진행했다.

 

 

기본 구조

제목(Subject), 본문(Body), 꼬리말(Footer)

(커밋 타입) 제목

본문 내용

꼬리말
(이슈 넘버 등)

 

커밋 타입(Commit Type)

• feat : 새로운 기능에 대한 commit
• fix : 수정에 관한 commit
• style : 코드 스타일에 관한 commit
• refactor : 코드 리팩토링에 대한 commit
• test : test code 작업 및 수정에 대한 commit
• docs : 문서 작업에 관한 commit

제목 (Subject)

• 제목은 50글자 이내로 작성한다.
• 첫글자는 대문자로 작성한다.
• 마침표 및 특수기호는 사용하지 않는다.
• 영문으로 작성하는 경우 동사(원형)을 가장 앞에 명령어로 작성한다.
• 과거시제는 사용하지 않는다.
• 개조식 구문으로 작성한다.

Body

• 선택사항
• 72이내로 작성한다.
• 무엇을, 왜 변경했는지 작성한다.

Footer

• 선택사항
• issue tracker id를 작성할 때 사용

 

예시 (Example)

feat: S3을 이용한 file upload, delete 기능 구현

게시글 업로드 시 사진을 S3에 저장

 

 

References

https://doublesprogramming.tistory.com/256