나의보물들/Git | GitHub

[Github] Git Commit Message Convention

솔솔하네 2024. 11. 10. 19:58
반응형

🍀 Git Commit Message Convention이란?

프로젝트 참여자들이 일관된 형식의 커밋 메시지를 작성하기 위한 규칙 줄여서 Git 커밋 컨벤션이라고도 함.

 

 

🍀 Git Commit Message Convention을 지켜야 하는 이유

정해진 규칙에 따라 커밋 메시지를 기재함으로써 개발자들이 서로의 작업을 이해하고 효율적으로 대처 할 수 있는 프로젝트 환경을 만들 수 있음.

 

 

🍀 Git Commit Message 작성법

### Git 커밋 메시지 컨벤션 기본 포맷 ###
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]

<type>은 변경 사항의 유형 중 하나를 나타냄

  • feature or feat : 새로운 기능 추가
  • fix : 버그 수정
  • docs : 문서 변경
  • test : 테스트 코드 수정
  • refactor : 코드 리팩토링
  • style : 스타일 수정(코드 의미에 영향을 주지 않는 변경 사항 ex-공백, 세미콜론 등 스타일 수정)
  • perf: 성능 개선
  • chore : 기타 작업(빌드 부분 혹은 패키지 매니저 수정 사항)

<description>에는 변경 작업의 제목이나 간단한 요약 작성

  • 50자 이내로 간결하게 작성
  • 영문인 경우 대문자로 시작
  • 마침표 사용 x

<body>는 선택 사항으로 작업 내용이 복잡하거나 상세한 내용 남겨야하는 경우 작성

  • 여러줄로 작성 가능
  • 보통 한줄 당 약 72자 이내로 작성

<footer>는 선택 사항으로 코드 작업과 관련된 이슈 번호 또는 참조 링크 등을 추가

  • 특정 작업이나 이슈 해결한 경우 일반적으로 “Closes#작업번호 또는 이슈번호”같은 형태로 기재

 

 

🍀 Git Commit Message 작성 예시 

feat: 사용자 프로필 페이지 추가

- 사용자 프로필 페이지 라우팅 구현
- 프로필 정보를 보여주는 프로필 카드 컴포넌트 구현
- 프로필 수정 기능 구현

Closes #123

 

 

 

🍀 Git Commit Message Template 저장해서 작성해보기 1 [Git Bash]

ⓐ .gitmessage.txt 파일 생성 후 아래와 같이 파일 내용 복붙 후 저장.

# <타입> :[화면단위] <제목> 형식으로 작성하며 제목은 최대 50글자 정도로만 입력
# 제목을 아랫줄에 작성, 제목 끝에 마침표 금지, 무엇을 했는지 명확하게 작성

#######################
# 본문(추가 설명)을 아랫줄에 작성

########################
# 꼬릿말(footer)을 아랫줄에 작성 (관련된 이슈 번호 등 추가)

########타입 예시########
# feature : 새로운 기능 추가
# fix : 버그 수정
# docs : 문서 수정
# test : 테스트 코드 추가
# refactor : 코드 리팩토링
# style : 코드 의미에 영향을 주지 않는 변경사항
# chore : 빌드 부분 혹은 패키지 매니저 수정사항
########################

########작성 예시########
# fix :[조인게시판 페이지] 조인게시판 API 호출 후 401에러 시 로그인 화면 이동
# - 게시글 조회
# - 게시글 수정
########################

 

ⓑ 아래 명령어로 생성한 txt파일을 Commit Template으로 지정.

git config --global commit.template <.gitmessage.txt 경로>

 

ⓒ 이후 변경 사항 스테이지에 올린 후 git commit  명령어 입력시 지정한 템플릿 파일이 vi 에디터 환경으로 나옴.

 

ⓓ 입력모드 ‘i’ / 입력모드 끝 ‘esc’ / 저장 후 종료 ‘wq!’

 

 

🍀 Git Commit Message Template 저장해서 작성해보기 2 [InteliiJ]

Git Bash의 ⓐ, ⓑ 수행 후

 

ⓒ IntelliJ에서 commit 메뉴 클릭.

 

ⓓ 저장해둔 템플릿이 나오면 양식에 맞춰 작성 후 Commit 버튼 클릭.

 

 

 

🍀 최종적으로 Git Commit  완료 후 확인

 

 

1) IntelliJ

 

2) Sourcetree

 

3) Git Bash

 

 

💚 참고 사이트

https://yozm.wishket.com/magazine/detail/1974/