[Git] 커밋 메시지 작성하기

촐옹·2021년 1월 26일
7

Git

목록 보기
1/1

왜 커밋 메시지를 규칙있게 작성해야 하는가?

기존에는 git commit message를 터미널에서 간단하게 작성했었다.

git commit -m "Add: first commit"

도대체 뭘 수정했는 지 알 수 없었던 커밋 메시지...pull request에 자세한 수정사항을 작성했기 때문에 더더욱 커밋 메시지의 중요성을 몰랐던 것 같다.

최근 개인 작업물을 깃에 올리면서, 커밋 메시지를 좀 더 규칙적으로 쓰면 좋겠다는 생각이 들었다. 남들이 봐도 어떤 부분이 변경되었는 지, 어떤 문제가 해결되었는 지 등등 쉽게 알아볼 수 있도록 말이다.

커밋 메시지 작성 컨벤션

구글링해보니 역시 커밋 메시지도 권장하는 컨벤션이 있었다.
👉 Udacity Git Commit Message Style Guide

1. Type : Subject (제목)

  • feat: 새로운 feature
  • fix: 버그 등 수정
  • docs: 문서 내용 변경
  • style: 포맷, 세미콜론 수정 등 코드가 아닌 스타일에 관련된 수정
  • refactor: 리팩토링 코드
  • test: 테스트 코드 추가 및 리팩토링 테스트 등
  • chore: build task 수정, 프로젝트 매니저 설정 수정 등

제목에는 커밋이 무엇을, 왜 수정했는 지 요약해서 작성하며, 50자를 넘지 않도록 한다.


보통 제목까지 작성하면 충분해서 아래는 선택사항이다.

2. Body (내용)
3. Footer (마무리)

여러 줄의 커밋 메시지 작성 방법

  1. "로 시작해 엔터를 눌러 여러 줄의 메시지를 작성

"로 시작하면 다음 "가 나오기 전까지 엔터를 눌러도 명령어로 인식하지 않는다.

git commit -m "첫 번째 줄
2번째 줄
3번째 줄
4번째 줄
"

커밋 메시지 예시

Feat : 메인 페이지 아이콘 svg으로 교체

완성도를 높이기 위해 기존 sprit 이미지로 작업했던 아이콘들을 svg로 교체

Issues: #11

2개의 댓글

comment-user-thumbnail
2021년 1월 31일

잘 보고 갑니다 ㅎㅎ 역시 깔끔한 정리👍🏻

1개의 답글