Udacity Git Commit Message Style Guide

메시지 구조

커밋 메시지는 제목, 본문(선택 사항), 바닥글(선택 사항) 세 부분으로 구성됩니다. 레이아웃은 다음과 같습니다.

type: Subject

 

body 

 

footer

 

제목은 메시지 타입과 제목으로 구성됩니다.

 

타입

타입은 제목에 포함되며 아래 타입 중 하나를 선택합니다.

- feat: 새로운 기능
- fix: 버그 수정
- docs: 문서 변경
- style: 서식, 세미콜론 누락, 기타 등; 코드 변경 없음
- refactor: 프로덕션 코드 리팩토링
- test: 테스트 추가, 테스트 리팩토링; 프로덕션 코드 변경 없음
- chore: 빌드 작업, 패키지 매니저 구성 등 업데이트, 기타 등; 프로덕션 코드 변경 없음

 

제목

제목은 50자를 넘지 않아야 하며, 대문자로 시작하고 마침표로 끝나지 않아야 합니다.
명령형 어조를 사용하세요. 커밋은 무엇을 했는지가 아니라 무엇을 하는지를 설명합니다.

예를 들어, changed 또는 changes가 아닌 change를 사용하세요.

 

본문
모든 커밋이 본문이 필요할 만큼 복잡한 것은 아니므로 선택 사항입니다.

커밋에 약간의 설명과 컨텍스트가 필요한 경우에만 사용합니다. 

본문은 커밋의 방법보다는 커밋의 내용과 이유를 설명하는 데 사용하세요.
본문을 작성할 때는 제목과 본문 사이에 빈 줄이 있어야 하며, 각 줄의 길이는 72자 이내로 제한해야 합니다.

바닥글
바닥글은 선택 사항이며 이슈 트래커 ID를 참조하는 데 사용됩니다.

 

커밋 메시지 예시

feat: Summarize changes in around 50 characters or less

 

필요한 경우 더 자세한 설명 텍스트를 입력합니다. 약 72자 정도로 줄입니다.

어떤 상황에서는 첫 줄이 커밋의 제목으로 취급되고 제목으로 처리하고 나머지 텍스트는 본문으로 처리하는 경우도 있습니다.

요약과 본문을 구분하는 요약과 본문을 구분하는 빈 줄은 매우 중요합니다(본문을 완전히 생략하지 않는 한).

'log', 'shortlog', 'rebase`와 같은 다양한 도구를 함께 실행하면 혼동될 수 있습니다.

 

이 커밋으로 해결하려는 문제를 설명하세요. 이 변경을 하는 이유에 집중하세요.
이 변경을 수행하는 방법(코드에서 설명)이 아니라 왜 수행하는지에 집중하세요.
이 변경으로 인한 부작용이나 다른 직관적이지 않은 결과가 있나요?
변화가 있나요? 여기에 설명할 수 있는 곳이 있습니다.

 

빈 줄 뒤에 단락을 추가할 수 있습니다.

 - 글머리 기호도 괜찮습니다.
 - 일반적으로 글머리 기호에는 하이픈 또는 별표가 사용되며 그 앞에는
   공백이 하나 있고 그 사이에 빈 줄이 있습니다. 하지만 규칙은 다양합니다.

 

이슈 트래커를 사용하는 경우에는 다음과 같이 하단에 해당 트래커에 대한 참조를 넣으세요:

 

Resolves: #123

See also: #456, #789

 

출처

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