이론 공부

Git 커밋컨벤션이란?

우주속공간 2024. 4. 3. 21:05

(Git Commit Message Convention)이란...  커밋메세지를 작성할때 사용하는 규칙같은 것이다. 

 

⇒ 커밋 메세지를 어떻게 작성할지 개인 또는 팀의 스타일에 맞게 규칙을 정한 후에 , 정해진 양식대로 커밋메세지를 작성한다.

⇒ 이렇게 작성하면 통일성을 가지고 체계적인 일처리가 가능해서 더 나은 협업이 가능하다.

⇒ 또한 어떤 내용인지 알아보기도 쉬워서 가독성도 좋다.

 

commit 할때 메세지 구조는 다음과 같다.

 

  • Commit Type : 태그와 제목 형식으로 구성되고, 태그는 영어로 쓰되 첫 문자는 대문자로 한다. 작업유형를 나타내는것이다.
    • feat, fix, docs, style, refactor 등 다양한 작업유형을 나타내는 type이 존재한다. 
  • Subject : 제목. 50자 이하로 작성해야한다. 대문자로 시작하고 마침표로 끝내지않는다. 명령문으로 작성한다.
  • Body : 72자 내로 작성, 최대한 상세히 작성한다.
    • 코드 변경의 이유를 명확히 작성할수록 좋다
    • 어떻게 보다는 무엇을, 왜 하는지 설명한다
  • footer : 선택사항이고 이슈트래커 ID를 작성한다.

 

 

<예시>

feat: home 페이지에 무한스크롤 기능 추가

home 페이지에서 페이지를 내렸을때 끝점에 닿으면 데이터를 10개씩 더 가져와서 무한스크롤 기능을 추가함. 

 

 

 

< 참고 자료 >

 

Git | git 커밋 컨벤션 설정하기

 

Git | git 커밋 컨벤션 설정하기

개발자로 시작한지 얼마 안되고 나서, 첫 직장은 지금도 다니고 있는 모든것을 처음부터 새로 시작하는 스타트업이다.프론트엔드는 작성자 혼자 뿐이었고, 아무것도 모르는 주니어 개발자가 하

velog.io

[Git] Commit Message Convention(커밋 메시지 컨벤션)

 

[Git] Commit Message Convention(커밋 메시지 컨벤션)

안녕하세요.🐱‍🐉 오늘은 Git 커밋 메시지 작성법에 대해 정리해볼게요. Udacity Git Commit Message Style Guide를 참고하여 작성했어요~! 커밋 메시지, 왜 중요할까? 자바 스프링의 예전 커밋 로그를 보

string.tistory.com

https://aroundlena.tistory.com/55

 

[Git] git 커밋 컨벤션 (Git Commit Message Convention)

[Git] git 커밋 컨벤션 (Git Commit Message Convention) ** 개인 기록용 현재 일하고 있는 팀에 커밋 컨벤션이 없다. 그러다보니 사람들이 커밋시에 보통 작업번호를 적고 끝나는 경우가 많은데 그러다보니

aroundlena.tistory.com