[Git] Git conventional commit 규칙

본 포스팅을 통해 커밋 진행시 관용적으로 사용되는 규칙에 대해 소개하고자 한다.

커밋

[커밋 메시지 구조]

"type : subject"

"body"

"footer"

 

[유형 - type]

1. fix : 코드의 버그를 패치

2. feat : 코드베이스에 새로운 기능 추가

3. style : 코드 스타일링과 관련된 기능 및 업데이트

4. refactor : 코드 리펙토링

5. test : 코드 테스트

6. docs : 문서 수정

7. chore : 정기적인 코드 유지 관리

 

[주의사항 - subject, body, footer]

1. subject, body, footer 사이에 빈 줄 (enter)를 기입

2. 공백 오류 주의

3. 불필요한 문장 부호 제거

4. 마침표로 subject 줄을 끝내지 않도록 함

5. subject과 각 문단을 대문자로 표시

6. subject는 명령어로 작성

7. body에는 변경한 내용과 변경한 이유를 설명

 

---

커밋 메시지는 누가 봐도 명확하고 의미가 있어야 한다. 좋은 커밋 메시지는 단기적으로 협업에 필수적으로 기여를 할 것이며 이에 국한되지 않고 장기적으로는 추후에 팔로워에게도 큰 도움이 될 것이다.

 

 

Ref : https://www.freecodecamp.org/news/writing-good-commit-messages-a-practical-guide/