Git commit 메세지 컨벤션

커밋 유형

· init : 초기 설정

· feat : 새로운 기능 추가

· fix : 버그 수정

· docs : 문서 추가 / 작성

· style : 스타일 관련 기능(코드 포멧팅, 세미콜록 누락, 줄바꿈, 코드 자체 변경이 없을 경우)

· refactor : 코드 리펙토링

· test : 테스트 코드 추가 / 수정

· build : 빌드 업무

· ci : CI 관련 설정 수정에 대한 커밋

· chore : 패키지 매니저 수정, 그 외의 것(ex, gitinore 등)

​

​

커밋 규칙

1. 제목과 본문을 빈 행 분리

2. 제목 행 50자로 제한

3. 제목 행의 첫 글자는 대문자로 시작

4. 제목 행 끝에 마침표를 넣지 않는다.

5. 제목 행에 명령문을 사용하고, 과거형을 쓰지 않는다.

6. 본문은 72자마다 끊어 줄을 바꿔준다.

7. 본문을 사용하여 변경한 내용과 이유 설명 (무엇, 왜)

​

​

예시를 보여드리면 아래 사진과 같습니다.

​

무엇보다!

리뷰어들이 커밋 메시지를 보았을 때 확실하게 알 수 있도록 설명해두는 것이 중요합니다.

누군가가 자신의 코드를 바로 파악 할 수 있다는 생각은 하면 안됩니다.

스터디를 하면서 가장 중요했던 내용이 아니였나 싶습니다.

​

만약 회사를 다니시는 분이시라면 회사 또는 팀의 Commit 규칙을 따르는 것이 중요하고

정해진 룰이 없다면 함께 정해가는 것이 좋을거 같네요

​

좋은 작성법 또는 추천하는 내용은 댓글로 남겨주세요.