[gitHub] 커밋 컨벤션

개발은 대부분 협업이 디폴트이기 때문에 주석을 남기듯 커밋에 대한 메시지를 남겨 어떤 부분이 바뀌었는지 공유해야 한다.

 

 

Commit Message의 구조

type: subject //type: 어떤 의도인지 명시 //subject: 마침표 없이, 동사를 가장 앞에 두고, 첫 글자는 대문자
body //긴 설명이 필요한 경우, 무엇을 왜 했는지
footer //issue tracker ID를 명시하고 싶은 경우에 작성

 

 

type

어떤 의도인지 명시

feat	새로운 기능 추가
fix	버그 수정
docs	문서의 수정
style	코드의 스타일 변경 (코드 정리)
refactor	코드를 리팩토링
test	테스트 관련한 코드 추가 / 수정
chore	코드 수정 없이 설정 변경
build	빌드 파일 수정
ci	CI 설정 파일 수정
perf	성능 개선
rename	파일 혹은 폴더명 수정
remove	파일 삭제

 

 

subject

제목

• 마침표를 사용하지 않는다

• (영어인 경우) 동사를 가장 앞에 둔다

• (영어인 경우) 대문자로 시작한다

• 완전한 서술형 문장이 아닌 개조식 구문으로 작성한다

 

 

body

본문

• 한 줄당 72자 내로 작성

• 무엇을 왜 변경했는지 상세히 설명

 

 

footer

꼬리말

• 선택사항, 이슈 트래커 ID를 작성

• '유형 : # 이슈 번호' 형식으로 사용

• 여러 개의 이슈 번호를 적을 때는 쉼표로 구분

Fixes	issue 수정중 (아직 해결 안됨)
Resolves	issue 해결 완료
Ref	참고할 issue 존재 시
Related to	해당 커밋에 관련된 이슈 번호 (아직 해결 안됨)

 

 

       예시 

Fix : 리스트 생성 시 뜨는 오류 //제목
- key error 오류, key 값 설정해서 처리 //자세하게 설명
- Resolves : #123 //선택 사항

Fix : 리스트 생성 시 뜨는 오류 //제목

key error 오류, key 값 설정해서 처리 //자세하게 설명

Resolves : #123 //선택 사항

첫번째와 같이 '-'로 나눠줘도 되고, 문단으로 나눠줘도 된다.

 

 

---

 

pull request를 할 때에만 자세히 적거나 최대한 짧게 커밋 메시지를 작성했었다.

늘 마음 한켠에 설명을 좀 해놔야 좋을 것 같다고 생각만 했었는데

이렇게 찾아보고 정리해놨으니까 앞으로 제대로 써야지 다짐