'깃/커밋 컨벤션' 에 대해 알아보자

 

오늘은 깃/커밋 컨벤션에 대해 알아보고자 합니다. 

깃/커밋 컨벤션?

Git을 통해 Commit을 할 때 변동 사항 등을 Commit 메시지에 적을 수 있습니다.

 

시간이 지남에 따라, 혹은 협업 /프로젝트를 진행하면서 Commit이 쌓이면,

나중에 봤을 때 가독성을 포함하여 내용을 한눈에 파악하기 어려워질 수 있습니다. 

 

이를 해결하기 위해 사전에 어떻게 표기할지 정한 과정이 깃 커밋 컨벤션입니다. 

 

 

자료를 찾다 보니 Udacity Style을 많이 사용한다는 것을 알게 되었고, 

이를 기준으로 정리해 볼까 합니다.  

 

 

메시지 구조

크게 3가지로 구분합니다. 

 

type : subject

body

footer

 

type 

타입은 제목과 함께 다음의 유형들을 포함합니다.

 

feat:  새 기능 

fix: 버그 수정

docs: 문서 수정

style: 포멧팅, 세미콜론 빠진 것 등 (코드의 변경이 없는 경우)  

refactor: 코드 리펙토링( = 결과의 변경 없이 코드의 구조를 재조정 ) 했을 때

test: 테스트 추가, 리펙토링 테스트 (production code 변화 없을 때)

chore: 빌드 업무 업데이트, 패키징 매니저 구성파일 등  (production code 변화 없을 때)

 

subject(제목)

제목은 50줄을 넘어서는 안되고,

대문자로 시작해야 하며, 마침표로 끝나면 안됩니다.

 

영문으로 표기 할 시, 커밋에 무엇을 했는지 설명할 때는 명령조로 써야 합니다.

ex) changed 나 changes가 아니라  change 

body(본문)

선택사항으로서,

약간의 설명이나 맥락이 필요한 경우에 사용하면 됩니다.

 

이때 어떻게가 아닌 왜, 무엇을 변경했는지 위주로 적어야 합니다. 

 

body를 작성할 때 제목과 본문 사이엔 빈 줄이 필요하며,

한 줄에 72자 이내로 작성해야 합니다.

footer (바닥글)

선택사항으로서,

ID를 통해 이슈를 참조할 때 사용할 수 있습니다.  

 

 

원본 내용은 아래에서 확인 할 수 있습니다. 

 

https://udacity.github.io/git-styleguide/

Udacity Nanodegree Style Guide

 

 

깔끔하게 정리하신 분이 있어서 추가로 남깁니다.

https://hyunjun.kr/21

Git Commit Convention, 깃 커밋 컨벤션