Commit Messages

좋은 커밋 메세지를 써야 하는 이유

• 면접관들이 커밋 히스토리를 살펴볼 수 있음
• 코드의 변화와 이유를 한 눈에 파악할 수 있음
• 프로젝트를 잠시 놓았다 다시 작업할때 사고의 과정과 흐름을 복기할 수 있음

좋은 커밋 vs 나쁜 커밋

• 나쁜 커밋 : fix a bug
  • 애매모호한 표현으로 혼란을 줌
  • 이유가 명시되지 않음

• 좋은 커밋
  • 커밋의 이유를 명시함
  • 수정된 부분이 어떤 문제를 어떻게 해결했는지 명시함

좋은 커밋을 작성하는법

커밋을 Subject와 Body의 두 부분으로 나누어 작성

• Subject : 수정한 부분에 대한 간략한 설명
  This is the change I made to the codebase.
  • Github는 72글자 제한이 있기 때문에 그 이하로 작성하는 습관 들이기

• Body : 간결하지만 확실한 설명
  Describe the problem your commit solves and how.

Add missing link and alt text to the company's logo

Screen readers won't read the images to users with disabilities without this information

• subject가 코드의 행동을 명시
• body가 커밋의 이유를 명시
• subject와 body가 공백행으로 분리 - 읽기 쉬움

언제 커밋을 해야하는가?

커밋 : 커밋이 만들어진 시점에서 코드의 스냅샷

• 코드에 의미있는 수정을 할 때마다 ➡️ 진행 상황을 파악할 수 있음

간결한 커밋메시지

• 모국어가 영어가 아닌 사람들도 쉽게 이해할 수 있도록 간결한 영어 표현을 사용해야함
  장황하지 않고 축약되었지만 쉽게 이해 가능한 표현

관련한 매우 좋은 자료가 있어서 첨부

좋은 커밋을 위한 영어 사전
https://blog.ull.im/engineering/2019/03/10/logs-on-git.html

---

참고 및 출처
https://www.theodinproject.com/lessons/foundations-commit-messages#when-to-commit
https://cbea.ms/git-commit/
https://www.conventionalcommits.org/en/v1.0.0/