협업 Tip

Git 커밋 메세지 컨벤션

sichan-dev 2024. 10. 22. 13:22

커밋의 단위는 기본적으로 하나의 기능 혹은 오류 수정이다. 

하나의 커밋에 기능이 2개 들어간다거나, 꽤나 자주 보이는 "중간 커밋" 어쩌구는 좋지 않다.

협업할 때 어떤 커밋으로 돌아가야 할 때, 직관적인 메세지를 넣어줘야 편하다... 

 

전 세계 개발자들이 사용하는 컨벤션이 있는데 무조건은 아니지만, 잘 모르겠다면 그냥 이걸 쓰면 된다.

type: 커밋의 작업 내용 간략히

body (optional) : 상세 내용
...
...
...

footer (optional) : 특정 이슈의 해결 작업일 때

( 이슈가 해결되면 Jira 같은데서 관리하는 Issue 번호를 기입한다 )

 

기본 Form에서 예시를 들자면, 

feat: 파일 업로드 기능 변경

파일 서버 대신 AWS S3에 파일이 업로드 되도록 변경 
 - 원본 이미지 Bucket 경로 : ~/~/
 - 썸네일 Bucket 경로 : ~/~/

Closes #121

 

Type의 종류

feat 새로운 기능 추가
fix 버그 수정
docs 문서 수정
style 공백, 세미콜론 등 스타일 수정
refactor 코드 리팩토링
perf 성능 개선
test 테스트 추가
chore 빌드 과정이나 기타 기능 (Swagger 등) 수정

 

< Git 이모지 >

https://gitmoji.dev/