1. 커밋 메시지를 읽을 사람

  • 코드의 총괄적인 책임자: 커밋한 사람이 쓴 코드가 커밋 메시지대로 쓰였는지를 검사. 커밋 메시지는 변화한 코드 이해를 도움.

  • 그 커밋을 통해 발생한 버그를 고치는 사람

  • 그외

2. 커밋 메시지 역할

  • 커밋 전후 전체적인 변화를 설명하는 메시지로, 변화의 맥락과 동기가 설명돼야 한다.

  • 커밋 메시지 내용은 PR 설명, 코드 주석과 역할이 다르므로 이를 잘 구분해야 한다.

    • 코드의 구체적 기능에 대한 내용이라면, 주석으로 써야한다.

    • 커밋 메시지는 ‘변화의 동기와 변화의 내용’에 초점을 둬야 한다.

3. 커밋 메시지의 형식

  • 커밋 타이틀

    • 커밋의 타입을 한 단어로 먼저 쓰고(Udacity 스타일), 그 다음에 커밋의 주요 내용을 설명하는 동사로 시작하는 간단한 문장을 50자 이내에 쓴다.

      • 커밋의 타입은 주로 다음과 같은 것이 쓰인다.

        • feat

        • fix

        • chore

        • refactor

        • docs

        • style

        • test

        • comment

        • rename

    • 커밋 타이틀의 형식 예시

1

feat: Impl new payment gateway

출처

https://developer.squareup.com/blog/how-square-writes-commit-messages/ https://hyunjun.kr/21