깃 커밋 컨벤션 (git commit convention)

 

 

깃 협업을 위한 형상관리 툴의 표준으로 자리잡았습니다.

깃 커밋 메시지 작성 시 개발자 마다 다른 기준과 형식을 사용하여 가독성이 떨어지는 상황이 발생할 수 있습니다.

깃 커밋 메시지 작성을 위한 가이드 라인을 소개합니다.

 

 

1. 좋은 커밋 메시지를 위한 7가지 규칙

 

1) 제목과 본문은 공백으로 구분한다.

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

3) 제목의 첫 글자는 대문자로 작성한다.

4) 제목 줄은 마침표로 끝내지 않는다.

5) 제목은 명령 형태로 작성한다.

6) 본문은 영문 기준 72자마다 줄 바꾸기를 진행한다.

7) 본문에는 어떻게 보다 무엇을과 왜에 대해서 설명한다.

 

 

2. 커밋 메시지의 구조

 

<타입(type)>[범위(scope, 선택사항)]: <제목(subject)> <한줄 공백(BLANK LINE)> <본문(body, 선택사항)> <한줄 공백(BLANK LINE)> <꼬리말(footer, 선택사항)>

•  

 

타입의 종류

• feat : 새로운 기능의 추가, 삭제, 변경 등
• fix : 버그 수정
• docs : 문서 추가, 삭제, 변경
• style : 포맷, 정렬 등의 변경과 같이 스타일과 관련된 수정
• refactor : 코드 전면 수정
• test : 시험을 위한 코드 추가, 삭제, 변경 등
• chore : .gitignore 차링 처럼 외부 사용자가 관심 없는 파일이나 빌드, 패키지 매니저, CI 등과 관련된 파일의 변경

 

 

꼬리말에 추가한 좋은 내용 : 해결한 이슈나 참고할 부분 명시

 

Resolves : #123 See also : #456, #789

 

3. 한국어로 커밋 메시지 작성하기

 

1. 제목은 개조식으로 작성한다.
2. 메시지 타입의 한국어화
3. 가급적 한 가지 언어로 작성한다.
4. 제목, 본문 줄 제한을 조정한다.(제목은 25자 이내, 본문은 36자마다 줄 바꿈)

 

메시지 타입 예)

• feat : 기능 추가, 기능 삭제, 기능 변경
• fix : 버그 수정
• docs : 문서
• style : 형식(스타일)
• refactor : 개정
• test : 시험
• chore : 기타

 

---

 

파이썬 코드로 배우는 Git / GitHub 도서에 수록된 내용입니다.

전체 내용을 보시려면 도서 구입을 추천합니다.

도서구입 : http://www.yes24.com/Product/Goods/115802695

파이썬 코드로 배우는 Git&Github - YES24