[Git-Hub] 커밋 메시지 규칙

 

개인/팀 내에서 어떤 수정사항이 발생했는지 파악하기 쉽도록 커밋 메시지 규칙을 사용합니다!

 

- 메시지 구조 

Header, Body, Footer는 빈 행으로 구분합니다.

타입 : 제목  // Header

본문  // Body

바닥글  //Footer

 

- Header 

Header는 필수로 작성되야할 부분이며, 타입은 해당 커밋의 성격을 나타냅니다.

• 타입(Type)

이름	내용
feat	새로운 기능 추가 또는 변경한 경우
fix	버그 수정한 경우
build	빌드 관련 파일 수정 / 모듈 설치 또는 삭제한 경우
chore	코드의 수정없이 설정을 변경한 경우
ci	ci 관련 설정 수정한 경우
docs	코드 변화없이 문서(주석) 추가 또는 수정한 경우
style	코드 스타일 혹은 포맷 등을 수정한 경우 (들여쓰기 같은 포맷이나 세미콜론 빼먹은 경우)
refactor	코드 리팩토링한 경우
test	테스트 코드 추가/수정한 경우
perf	성능 개선한 경우

 

- Body 

커밋에서 수정된 상세내역을 작성합니다. 이후 히스토리 파악이나 코드 변경의 의미를 파악하기 위한 목적으로 '무엇을, 왜' 수정했는지에 대해 작성하도록 합니다. Header에서 충분히 표현이 되었다면 Body는 생략이 가능합니다.

 

- Footer

바닥글로 어떤 이슈에서 왔는지 등과 같은 참조 정보들을 추가하는 용도로 사용하고, 생략 가능합니다.

 

- 작성 예시

git commit -m "fix: 수정 버튼 클릭 이벤트 이슈 수정

블로그 페이지에서 수정 버튼 클릭 시,
페이지 전환 안되는 이슈 수정.

resolves: #1234