커밋 메세지를 작성하는데 하나의 룰을 정하고 개인/팀 내에서 같이 사용한다면,나중에 Commit 메시지 만으로도 어떤 수정 사항이 발생하였는지 파악하기 쉬울 것입니다.

어떤 룰을 사용할까

좋은 룰은 파악하기 쉽도록 명확한 메세지를 작성해야 합니다.

커밋 메시지의 사용이유는 미래의 나 혹은 함께 일하는 동료들에게 Repository 변경 이력을 알려주는 메시지입니다. 통일된 원칙을 정하고 일관성 있게 작성해 업무 간에 발생하는 의사소통 문제를 줄이기 위해 사용됩니다. 커밋 메시지 스타일에는 여러 종류가 있지만, 의사소통은 하나의 약속이기 때문에 사람들 사이에 가장 많이 사용되는 Udacity Style을 사용하는 것이 소통에 있어 문제가 없을 것이라 생각해 Udacity Style을 사용하게 되었습니다.

메세지 구조

커밋 메세지의 구조는 Subject, Body, Footer세 부분으로 나뉘며,각 부분을 한 줄의 공백으로 구분합니다.

한 줄의 공백으로 구분하면, git log의 --oneline 옵션을 사용할 때,요약 메세지를 작성하는 Subject 부분만 확인할 수 있습니다.

만약, 공백으로 구분하지 않았다면 모든 메세지가 한 줄로 출력됩니다.

type : [#issueNumber - ] Subject

body

footer

제목 (Subject)

type : [#issueNumber - ] Subject

커밋에 대한 주요 내용을 간결하고 명확하게 작성합니다.

• 원문에 명령조로 작성하라고 되어있지만, 이는 영어에 한합니다.
• 한글로 작성할 때는, 구문 형태로 작성하면 간결합니다. 회원 생성 서비스 추가

제목은 항상 입력해야 하며,type과 함께 작성되어야 합니다.

제목은 최대 50자를 넘지 않도록 주의합니다.

제목의 마지막에 마침표(.)를 찍지 않습니다.

Type

Type은 항상 영문 소문자로 작성합니다.