Github&Git

[Git] 좋은 Commit message 규칙

기석김 2024. 5. 7. 23:34

프로젝트를 진행하면서 팀원들과 더욱더 협업하기 위해서는 규칙을 잘 지키는게 좋다

자신이 작성한 코드를 커밋했을때 규칙을 한번 알아보자

 

좋은 COMMIT MESSAGE 규칙

 

1.제목과 본문 사이 한 줄 띄어쓰기
2.제목은 50자 이내로 쓰기 
3.제목 첫 글자는 대문자 
4.제목 끝에 마침표 쓰지 않기 
5.제목은 명령문, 현재형으로 작성하기 
6.본문의 각 행은 72자 이내 
7.본문은 '어떻게' < '무엇'을, '왜'에 초점을 맞추어 작성

 

작업 타입 작업내용
update 해당 파일에 새로운 기능이 생김
🎉 add 없던 파일을 생성함, 초기 세팅
🐛 bugfix 버그 수정
♻️ refactor 코드 리팩토링
🩹 fix 코드 수정
🚚 move 파일 옮김/정리
🔥 del 기능/파일을 삭제
🍻 test 테스트 코드를 작성
💄 style css
🙈 gitfix gitignore 수정
🔨script package.json 변경(npm 설치 등)

 

 

규칙에 맞는 좋은 커밋메시지를 작성해야 하는 이유는?

 

• 팀원과의 원할한 소통

• 결과물을 다시 봤을때 깔끔한 기록

 

 

깃헙 커밋 규칙

 

작업타입: 작업내용

ex) ✨ update: 파일 생성 기능 추가

 

 

많이 쓰는 타입 

 

update :sparkles:

fix :adhesive_bandage:

bugfix :bug: