Web

github 커밋 메세지 정리

codingtori 2024. 10. 11. 19:21

개발 많이 하는 친구들 보니까 나처럼 막 커밋 메세지를 작성하지 않는다는 것을 알게되었다. 커밋 메세지도 일정한 규칙? 형식?이 있다고 한다!!! 그래서 이제부터는 이걸 지켜서 커밋을 하려고 노력할 예정이다...

 

 

google에 'github convention'이라고 검색하면 잘 정리되어 있는 글들이 많이 나온다... 근데 나의 학습과 암기를 위해 한 번 정리해 보도록 하겠다.

 

 

기본적인 커밋메세지 구조

 

제목(subject)

본문

꼬리말(footer)

 

※ 각각은 한 줄 띄어쓰기로 구분한다

 

종류

일단 내가 사용할 것 같은 것만 정리해두었다

  • feat : 새로운 기능 추가
  • fix : 버그 수정
  • docs : 문서 수정
  • style : 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우
  • refactor: 코드 리펙토링
  • test: 테스트 코드, 리펙토링 테스트 코드 추가
  • rename : 파일 혹은 폴더명을 수정
  • remove : 파일을 삭제

 

제목

  • 첫 글자는 대문자로 작성
  • 명령조로 작성
  • 특수기호나 마침표 사용하지 않음

 

 

 

 

푸터는 아직.....나중에 공부해서 추가해야징