커밋 컨벤션

이 글은 아래 영상 내용을 기반으로 작성되었습니다.

www.youtube.com/watch?v=OJqUWvmf4gg

 

 

전체 형식

 

<type>[(선택)scope]: <description>

[(선택) body]

[(선택) footer(s)]

 

 

body 와 footer 를 넣을 때는 --amend 옵션을 사용합니다.

 

type

 

이 커밋으로 인한 변경이 대략적으로 어떠한 유형의 변경인지를 명시합니다. 가장 대표적인 type의 예시로는

• fix : 버그를 고쳤을 때
• feat 혹은 feature : 기능과 관련된 변경
• 그 외 : build, style, chore, refactor, ci, test, docs

 

 

 

Scope

 

type 에 추가해서 넣을 수 있는 정보를 명시하고 싶을 때 사용합니다. 괄호 () 안에 명사만을 넣어야 합니다. 만일 엄청 중요한 커밋이라는 것을 명시하고 싶을 때는 ! 느낌표를 : 콜론 앞에 넣습니다. 딱히 추가적으로 명시하고 싶은 정보가 없다면 사용하지 않아도 됩니다.

 

 

 

Description

 

아주 간단한 커밋의 내용을 적습니다. 무조건 단수형에 현재형의 명사를 씁니다. 예를 들어 adds 나 added 가 아니라 'add' 라고만 적습니다.

 

 

 

Body

 

딱히 정해진 형식 없이, 그저 이 커밋으로 인한 변경을 적용하는 이유가 뭔지를 적습니다. 마찬Scope 와 마찬가지로 딱히 쓸 내용이 없으면 쓰지 않아도 됩니다.

 

 

 

Footer(s)

 

body 아래 한칸 띄고, 아주 간단한 단어들을 적습니다. 일반적으로 어떤 이슈와 관련된 것인지, 어떤 방법론을 사용했는지 등을 명시하는데 사용합니다. 예시는 아래와 같습니다.

 

Resolves #10

Development-Method: Pair Programming

With: James