좋은 git commit 메시지 작성하기 위한 7가지 약속

좋은 git commit 메시지를 작성하기 위한 7가지 약속

0. 영어로 작성

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

2. 제목은 영문 기준 50자 이내로

3. 제목 첫글자를 대문자로

4. 제목끝에  .  금지

5. 제목은 명령조 로

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

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

---

키워드 종류 와 커밋메시지 작성예시

Feat: 새로운 기능 추가

Fix: 버그 수정

Docs: 문서수정

Style: 스타일관련 기능 (코드 포맷팅, 세미콜론 누락 등)

Refactor: 코드 리팩토링

Test: 테스트코드, 리팩토링 테스트 코드 추가

Chore: 빌드업무 수정, 패키지 매니저 수정(.gitignore 수정)

 

커밋메시지 작성 예시

키워드 #이슈번호

 

커밋메시지 규칙을 맞춰서 작성하는 것이 개발자들 사이에서 협업이자 코드 소통인거 같습니다.

---

[참고] 아래 참고글에서 더 자세히 나타냈습니다. 참고바랍니다.

https://meetup.toast.com/posts/106

좋은 git 커밋 메시지를 작성하기 위한 7가지 약속 : NHN Cloud Meetup

 

https://jason-api.tistory.com/89

Git Commit Message 규칙