Git Commit Message Convention

이준영·2023년 8월 11일
0

🔶 Git

목록 보기
4/9

커밋 메시지 컨벤션

1. 커밋 유형지정

2. 제목과 본문을 빈행으로 분리

  • 커밋 유형 이후 제목과 본문은 한글로 작성하여 내용이 잘 전달될 수 있도록 할 것
  • 본문에는 변경한 내용과 이유 설명 (어떻게보다는 무엇 & 왜를 설명)

3. 제목 첫 글자는 대문자로, 끝에는 . 금지

4. 제목은 영문 기준 50자 이내로 할 것

5. 자신의 코드가 직관적으로 바로 파악할 수 있다고 자만하지 말자

6. 여러가지 항목이 있다면 글머리 기호를 통해 가독성을 높이자

- 변경 사항 1
- 변경 사항 2
- 변경 사항 3

규칙에 맞는 좋은 커밋 메세지를 작성해야 하는 이유

  • 팀원과의 소통
  • 편리하게 과거 추적 가능
  • 실무에서 큰 어려움을 겪지 않을 수 있도록

👍 잘 지킨 사례

한 커밋에는 한가지 문제만 담아야 한다!

너무 많은 문제를 한 커밋에 담으면 이후에 추적하거나 되돌릴때 어려울 수 있다.

profile
작은 걸음이라도 꾸준히

0개의 댓글