[Git] 깃허브 커밋 메시지 규칙

 

불과 한 달 전까지 나는 깃허브에 커밋할 때 
내 마음대로 커밋 메시지를 쓰곤 했다... 
(ex: user 로직 수정, 폴더 이동)

 

;_;

이렇게 쓰다보니 나는 편한데 
나중에 프로젝트 정리하려고 보니까 뒤죽박죽 예쁘지도 않고
그래서 요즘은 커밋 메시지 규칙에 따라 작성 중이다! 
보기 훨씬 편하고 통일감 있어서 좋다

(근데 다시 읽다보니 나는 제목 첫 글자를 소문자로 작성해서 앞으로 유의해야겠다...) 

 

 

---

🔥 커밋 메시지 구조

기본 커밋 메시지 구조는 제목, 본문, 꼬리말 세가지 파트로 나누고, 각 파트는 빈 줄을 두어 구분한다

 

🔥 커밋 메시지 작성 기본 7가지 규칙

• 제목과 본문을 한 줄 띄워서 구분 
• 제목은 영문 기준 50자 이하 
• 첫 글자는 대문자로 작성
• 제목 끝에 마침표 X
• 제목은 명령문으로 사용 
• 본문의 각 행은 영문 기준 72글자 이하
• 어떻게 보다는 무엇을, 왜

 

🔥 커밋 타입 (Commit Type)

feat	새로운 기능 추가
fix	버그 수정
build	빌드 관련 파일 수정
chore	빌드 업무, 패키지 매니징 수정
ci	CI 관련 설정 수정
docs	문서 수정
style	코드 스타일 수정 (기능 수정이 없는 경우)
refactor	코드 리팩토링
test	테스트 코드 수정
perf	성능 개선
comment	주석 추가 및 변경
init	초기 설정

 

저는 예시로

주석을 수정하고 간단히 커밋해 보았습니다!

 

---

아래는 참고 글입니다!

Git 커밋 메시지 규칙

 

[Git] 좋은 commit message 작성법