Git Commit Message

miz·2021년 6월 14일
0

Git Commit Message 작성

이 글은 https://edykim.com/ko/post/writing-good-commit-messages/ 을 읽고 제가 사용하는 방식을 만들고자 진행합니다.

정답이 아니며 제가 작성하는 방식을 정리하고자 올립니다.

  1. 커밋 메시지 헤드

    • [fix], [add], [change]를 시작에 적어준다.
    • 수정, 추가, 변경 중 요번 커밋에 수행한 작업에 따라 선택한다
  2. 메시지

    • 메시지는 간결하게 내가 커밋한 내용을 정리한다.
    • 첫 행은 변경에 대한 요약이다.
    • 변경은 한번의 커밋당 하나의 변경을 기본으로 한다.
  3. 빈행

    • 첫행에 요약을 적은 뒤 추가적인 내용을 적어야 할 때는 중간에 빈행을 삽입 한 뒤 추가적인 내용을 적는다
  4. 추가 메세지

    • 요약 이후 추가적으로 설명할 부분이 있으면 정리한다.
  5. 메시지 예시

[add] #이슈번호 추가한 내용

추가적으로 필요한 설명이 있을경우
  • 커밋메세지에 대한 좋은 의견이 있으시면 댓글 남겨주시면 감사하겠습니다!
profile
2년차 백엔드 개발자

0개의 댓글