git commit message

git에서 commit 할 때 내가 어떤 변경사항을 add 했는지
commit 메시지를 작성해야 하는데 위코드 notion 페이지에서 매번 찾기가 불편해서 내 블로그에도 기록하려고 한다

commit message 구조

Type: Subject = Title

body

footer

형식으로 commit message를 작성하면 되는데 요소 하나하나를 살펴보면

Type

타이틀 내부에 포함되고 subject 앞에 입력한다

1. Add : 레이아웃 / 기능 추가
2. Remove : 내용 삭제 (폴더 및 파일 삭제)
3. Modify : 내용 수정
   • JSON 데이터 format 변경
   • 버튼 색상 변경
   • 폰트 변경
4. Fix : 버그 / 오류 해결
5. Refactor : 코드 리팩토링
   • 멘토 리뷰 반영
   • 스스로 리팩토링
   • 중복된 코드 제거 Remove와 헷갈리지 않도록 주의
   • 불필요한 코드 제거 Remove와 헷갈리지 않도록 주의
   • 성능 개선
6. Docs : 문서에 관련된 수정작업
   • README.md 등

깔끔하게 작성하는 것도 중요하지만 무엇보다도, 제 3자가 봐도 이해가 잘 되도록 자세히 적어주는 것이다

그 밖의 https://webruden.tistory.com/486 이 사이트를 보면

1. Feat : 새로운 기능 추가 a new feature
2. Fix : 버그 수정
3. Style
   • 코드 포맷팅
   • 세미콜론 누락이나 코드 변경이 없는 경우
4. Test : 테스트 코드 추가
5. Chore
   • 빌드 업무 수정
   • 패키지 매니저 수정

Subject

50자를 넘기지 않고
문장의 끝에 마침표를 넣지 않는다
과거시제를 사용하지 않고
명령어로 작성한다

Body

선택사항이기 때문에 모든 commit message에 작성할 필요는 없다
Title 에 적은 내용 이외에 추가적으로 정보를 전달하고 싶을 때 추가적인 정보를 적어주면 된다
이 때 자세히 적어주면 좋을 것 같다

Footer

Body처럼 선택사항이긴 한데
보통은 이슈를 추적하기 위해 이슈 id를 넣어주기도 한다

참고내용
https://udacity.github.io/git-styleguide/