커밋 메시지 스타일 가이드

[kimdev1]

개요

커밋 메시지가 많이 누적 되가면서 각자의 스타일로 커밋메시지를 작성하게 되면 가독성이 떨어지고
협업에 있어서 어려움이 생길 염려가 있어 커밋 메시지 스타일 가이드를 정해두려 합니다.

메시지 구조

type: subject

body

footer

type : 커밋한 내용의 분류
subject : 커밋한 내용에 대해 작성
body: 긴 설명이 필요한 경우에 작성, 어떻게 했는지가 아니라, 무엇을 왜 했는지 작성, 최대 75글자
footer : issue tracker ID를 명시하고 싶은 경우에 작성

body와 footer는 선택이며 필수는 아닙니다.

타입 type

feat : 새로운 기능 추가
fix : 버그 수정
docs : 문서 수정
style : 스타일 변경(코드 수정 x)
refactor : 코드 리팩토링
test : Test 관련한 코드 변경항목
chore : 설정변경(코드 수정 x)

위의 타입은 예시일 뿐이며 다른 타입도 사용 가능합니다. ex) add: 파일 추가, mod: 파일 삭제 및 수정

참고사이트 Udacity Git Commit Message Style Guide