[Git] git commit 컨벤션 정리

Sieun·2023년 3월 30일
0

Git

목록 보기
2/5

1. Commit 메시지 구조

커밋 메시지는 크게 제목, 본문, 꼬리말 세 가지 파트로 나누고, 각 파트는 빈줄을 두어서 구분한다.

type(옵션): Subject // 제목
body(옵션) // 본문
footer(옵션) // 꼬리말
  • type : 어떤 의도로 커밋을 했는지 type에 명시한다.
  • subject : 최대 50글자가 넘지않아야하며, 마침표는 찍지 않는다. 영문으로 표기할 경우, 동사를 가장 앞에 두고 첫 글자는 대문자로 표기한다.
  • body : 긴 설명이 필요한 경우에 작성한다. 무엇을 왜 하였는지 작성하는 부분으로 최대 75자를 넘기지 않아야 한다.
  • footer : issue tracker ID를 명시하고 싶은 경우에 작성한다.

2. Commit Type

타입은 태그와 제목으로 구성되고, 태그는 영어로 쓰되 첫 문자는 대문자로 한다.

태그 : 제목 의 형태이며, : 뒤에만 space가 있음에 유의한다.

  • Feat : 새로운 기능을 추가할 경우
  • Fix : 버그를 고친 경우
  • Design : CSS 등 사용자 UI 디자인 변경
  • !BREAKING CHANGE : 커다란 API 변경의 경우
  • !HOTFIX :급하게 치명적인 버그를 고쳐야하는 경우
  • Style : 코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우
  • Refactor : 프로덕션 코드 리팩토링
  • Comment : 필요한 주석 추가 및 변경
  • Docs : 문서를 수정한 경우
  • Test : 테스트 추가, 테스트 리팩토링(프로덕션 코드 변경 X)
  • Chore : 빌드 태스트 업데이트, 패키지 매니저를 설정하는 경우(프로덕션 코드 변경 X)
  • Rename : 파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
  • Remove : 파일을 삭제하는 작업만 수행한 경우

Reference

[협업] 협업을 위한 git 커밋컨벤션 설정하기

profile
👩🏻‍💻 블로그 이전했습니당 ! https://sinetlsl.github.io/

0개의 댓글