git commit(커밋) 메시지 잘 쓰는 법, 잘 써야 하는 이유는??

커밋 메시지를 잘 작성해야 하는 이유는 무엇인가요??

---

1. 커뮤니케이션의 효율성 증대

 - 일관적이고 명확한 커밋 메시지는 다른 개발자가 더 쉽게 이해하도록 돕기 때문에 서로의 작업에 대한 이해도를 높이고 프로젝트 관리와 협업에 중요한 역할을 합니다.

2. 문제 해결 속도 향상

-  적절한 커밋 메시지 규칙은 메인테이너가 코드를 이해하는데 도움이 되며 향후 변경 사항을 더 쉽게 만들 수 있습니다. 또한 좋은 커밋 메시지를 사용하면 코드 문제를 더 쉽게 디버깅 할 수 있습니다. 문제가 발견되면 개발자는 커밋 메시지를 사용하여 언제 어디서 문제가 발생했는지 식별할 수 있다는 장점이 있습니다.

3. 문서화의 기능

- 적절한 커밋 메시지 규칙은 코드베이스 변경 내역을 제공하는 문서 역할을 할 수 있습니다. 이 기능은 프로젝트를 처음 접하거나 프로젝트에 신속하게 적응해야 하는 개발자에게 특히 유용할 수 있습니다.

 

 

좋은 커밋(commit) 메시지를 작성하기 위한 조건

---

1. 제목과 본문을 한 줄 띄워 분리하기

2. 제목은 영문 기준 50자 이내로(가독성), 영어 2글자 = 한글 1글자 이기 때문에,

        한글 기준으로는 약 30자 정도로 작성하면 된다.

3. 제목 첫글자를 대문자로(영어만 해당)

4. 제목 끝에 마침표(.) 금지

5. 제목은 명령조로 -> 과거형 X, 현재형으로 (ex 수정했음, 수정함X - > 수정 O)

6. 본문은 영문 기준 72자마다 줄 바꾸기

7. 본문은 어떻게 보다 무엇을, 왜 에 맞춰 작성하기

 

 

제목(subject, 필수)

---

 

형태

type: subject(제목)

 - :과 설명사이에 한개의 공백 유지하고 작성할 것

 - type은 대문자나, 소문자 하나로 통일하기 (나는 소문자 통일!)

 - 설명 일관되게 통일하기 (~기능 구현, ~작성, ~출력, ~삭제, ~생성, ~수정...)

 - 명령형, 현재형으로 작성하기

 

type

• feat: 새로운 기능 (기능 구현)
• fix: 버그 수정
• docs: documentation 변경
• style: 코드 의미에 영향을 주지 않는, 코드가 아닌 스타일에 관련된 변경사항(포맷, 공백, 빼먹은 세미콜론, 함수 이름 변경, 줄간격, 파일 이름, 의미없는 주석 삭제)
• refactor: 리팩토링에 대한 커밋(버그를 수정하지 않고 기능을 추가하지 않는 코드 변경)
• test: 누락된 테스트 추가 또는 기존 테스트 수정
• chore: 패키지 매니저 설정할 경우, 코드 수정 없이 설정을 변경 (eslint, prettier... 패키지 설정)

 

내용(body, 선택)

WHY 왜 이 커밋을 작성하게 되었는지

• 일반적으로 제목까지만 기재하면 충분하기 때문에 선택사항으로 기재하면 되며, 약간의 설명이나 전체 문맥을 설명해야 할 때만 사용한다. (commit메시지는 간단히 요약한 내용을 작성하고, 부족한 부분이 있으면 description에 추가하기)
• 작성할 때는 커밋에 대해 어떻게(How)가 아닌 무엇(What) 그리고 이유(Why)에 설명을 합니다.
• 현재형으로 작성
• commit을 할 때 추가로 자세하게 쓸 내용이 있는데 너무 요약해서 작성했다면, description에 추가 설명을 작성하기 (필수 x)
• 본문을 작성하고 싶을 때는, 제목과 본문을 한 줄 띄워 분리하기