How to write git commit message?

YongJunCha·2021년 4월 12일
0
post-thumbnail

정리되지 않은 커밋 메세지

커밋 메세지는 간결하게 내가 어떤 것을 변경했는지 표현해야한다.
위의 사진은 내가 안드로이드 앱을 만들면서 적었던 커밋 메세지다.
나름 노력했으나, 한눈에 기능이 추가 된 것인지 코드를 수정한 것인지,
정확히 알기가 힘들다.



Commit Message Rules

  • feat : 새로운 기능에 대한 커밋
  • fix : 버그 수정에 대한 커밋
  • build : 빌드 관련 파일 수정에 대한 커밋
  • chore : 그 외 자잘한 수정에 대한 커밋
  • ci : CI관련 설정 수정에 대한 커밋
  • docs : 문서 수정에 대한 커밋
  • style : 코드 스타일 혹은 포맷 등에 관한 커밋
  • refactor : 코드 리팩토링에 대한 커밋
  • test : 테스트 코드 수정에 대한 커밋

💡Tip

  • 제목 행에는 마침표를 넣지 않는다.
  • 간결성을 위해 제목 행은 50자 내로 작성할 것.
  • 설명은 제목 행에서 한 줄 띈다.
  • 제목행은 명령형으로 써줄 것.

✅ 적용 후

적용 후 전보다 훨씬 보기 좋은 커밋 히스토리가 되었다.
gitignorer 업데이트의 경우에는 chore로 하는 게 더 좋겠다고 블로그 작성중 생각하게 되었다.

0개의 댓글