Git 커밋 컨벤션

2796 단어 gitgit

😎 이 글은...

  • 안녕하세요. 신뢰 받는 백엔드 개발자가 되기 위해 나아가고 있는 오준영입니다.

  • 이 글은 제가 토이 프로젝트를 진행하며 배우고 공부하는 글을 정리하는 게시글 입니다.


Git 커밋 컨벤션이란?

  • 팀 협업을 위해 Git commit message의 규칙을 정해두는 것입니다.

Git 커밋 컨벤션을 사용하는 이유

  • Git의 커밋 히스토리를 읽는 것만으로도 같이 개발하는 팀원들끼리 따로 추가적인 시간을 들일 필요 없이 변경 사항을 이해하기 위함입니다.
  • 오류가 발생하여 코드의 롤백이 필요할 경우, 수 많은 커밋 중에서 cherry picking 할 수 있습니다.

commit 메세지 구조

  • 커밋 메시지는 팀원들과의 약속을 통해 정합니다.
  • 아래는 유다시티의 커밋 메시지 스타일 가이드를 따릅니다.
  • 기본적으로는 아래와 같이 제목/본문/꼬리말 로 구성됩니다.
<Type> : <Subject>
  
<BLANK LINE>
  
<Body>
  
<BLANK LINE>
  
<Footer>

1. Type

  • feat : 새로운 기능 추가
  • fix : 버그 수정
  • docs : 문서 수정
  • style : 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우
  • refactor : 코드 리펙토링
  • test : 테스트 코드, 리펙토링 테스트 코드 추가
  • chore : 빌드 업무 수정, 패키지 매니저 수정

2. Subject

  • 제목은 50자를 넘기지 않고, 대문자로 작성하고 마침표를 붙이지 않는다.
  • 과거 시제를 사용하지 않고 명령어로 작성한다.

3. Body

  • 선택사항이다.
  • 부연 설명이 필요하거나 커밋의 이류를 설명할 경우 작성한다.
  • 72자를 넘기지 않으며 제목과 구분하기 위해 한칸을 띄운다.

4. Footer

  • 선택사항이다.
  • issue tracker id를 작성할 때 사용한다.

마무리하며

  • 팀원들과 프로젝트를 진행하며 커밋 규칙을 정하고 진행했었습니다.
  • 규칙이기에 열심히 지키며 커밋을 했지만 이유와 구조에 대해서 잘 알지 못했었습니다.
  • 아직 기초가 많이 부족하다는 것을 느끼며 게시글을 마무리 하겠습니다.

참고


[Flutter / error / iOS] Try launching Xcode and selecting "Product > Run" to fix the problem: open ios/Runner.xcworkspace
백준 Baekjoon 2754번 학점계산 - JAVA

좋은 웹페이지 즐겨찾기

개발자 우수 사이트 수집

개발자가 알아야 할 필수 사이트 100선 추천 우리는 당신을 위해 100개의 자주 사용하는 개발자 학습 사이트를 정리했습니다
best100-homepage