본문 바로가기
GitHub/github 관리

[Git] Git Commit 컨벤션

by Develaniper 2021. 5. 1.

- 개요

 하려면 제대로 하자..

 깃은 그냥 내가 진행했던 프로젝트들을 올리는 저장소 정도로 생각하고 무조건 심심할때 커밋, 생각나면 커밋!! 을 했다.. 그러다보니 기록이 지저분하다는 생각과 커밋 메세지를 써도 이게 맞는건가? 라는 생각을 하게 되었다.

 제대로 된 깃헙활용을 하기 전에 커밋 컨벤션을 확실히 정리해 둘 필요성이 있는 것 같아 정리하게 되었다.

 

 

 

1. 구성

 커밋 메세지의 구성은 제목, 본문, Footer 세가지로 나뉜다.

 

- 제목(Subject)

  제목은 세부적으로 type과 제목으로 나뉜다. 타입은 이 커밋이 추가, 수정, 리펙토링 등 어떤 종류인지를 나타내고 제목은 말 그대로 제목을 나타낸다.

*type

  feat: 새로운 기능 추가

  fix:  버그 수정

  docs:  문서 수정

  style:  코드 포멧팅, 세미콜론 누락, 코드 변경이 없는 경우

  refactor: 코드 리펙토링

  test:  테스트 코드, 리펙토링 테스트 코드 추가

  chore: 빌드 업무 수정, 패키지 매니저 수정

*제목

     제목은 50자를 넘기지 않고, 문장의 끝에 마침표를 넣지 않습니다.  또한, 과거시제를 사용하지 않고, 명령어로 작성합니다.

 

 - 본문(Body)

 본문 내용은 선택사항입니다. 타이틀에 작성하지 못한 추가적인 내용을 작성하면 됩니다.

 - 푸터(Footer)

 푸터도 마찬가지로 선택사항이지만 이슈를 추적하기 위해 이슈 ID를 넣어주는 용도로 사용됩니다.

 

 

예시

feat: xx에 ~~기능을 추가// 타이틀

2020.12.04 00님의 기획 요구사항 변경으로 xx에 ~~를 추가했습니다. // 본문

Resolves:#220	// Footer

댓글