Git 커밋 메세지 스타일 가이드 및 Issue 종료하기

 문제인식

 

개발팀 단위로 작업을 하다보면 커밋메세지가 너무 다양해서 알아볼수가 없다.

아래처럼 다양한 커밋 메시지 스타일이 있다.

• 2022년 5월 12일 ~ 오류로 인해 작업함
• ~ 오류로 인해 작업함
• 기능 추가함
• 버그 수정함
• 테스트 코드 수정함
• 문서 추가함
• 설정 변경함
• ...

위 커밋메세지들을 나중에 정리하거나 찾기위해 메세지 스타일의 통일성을 느꼈다.

그런던중 git commit message style, convention 으로 찾아보고, 아래 자료를 바탕으로 규칙을 정하도록 하였다.

https://udacity.github.io/git-styleguide/

Udacity Nanodegree Style Guide

 

 Style & Convention

 

type: Subject

body

footer

type 적고, 한줄띄고 body 적고 마지막에 다시 한줄띄고 footer 적어야함

 

type에 들어올 수 있는 내용

• feat: A new feature ( 새로운 기능 )
  • new : 완전 새로운 기능
  • improve : 기존 기능에서 수정, 요구사항 변경으로인한 수정
• fix: A bug fix ( 버그 수정 )
• docs: Changes to documentation ( 문서 변경 )
• style: Formatting, missing semi colons, etc; no code change ( 서식, 세미콜론추가 등의 코드변경 없음 )
• refactor: Refactoring production code ( 프로덕션 코드 리팩토링 )
• test: Adding tests, refactoring test; no production code change ( 테스트, 리팩토링 작업, 프로덕션 코드 변경없음 )
• chore: Updating build tasks, package manager configs, etc; no production code change
  (빌드작업 업데이트, 패키지 관리자 구성 변경 등 프로덕션 코드 변경없음 )
• release : 릴리즈 배포 버전 기입용

subject에 들어올 수 있는 내용

• 제목으로 50자 이하로 간결
• 마침표 없어야함
• 이슈넘버가있을경우 #1234 - subject 형태로 기입

 

body에 들어올 수 있는 내용

• subject에 적지못한 상세내역을 작성
• 수정 내용을 * 로 여러가지 적을 수 있음
• 길어질 경우 개행을 통해 입력
• 히스토리 파악을 위해 왜 이 작업을 했는지 같이 적어주기

 

footer에 들어올 수 있는 내용

• 해당 커밋과 연관된 이슈 번호 입력
• 아래 명령어와 함께 이슈번호 기입시, commit 시 이슈 종료 가능
• ex) resolved : #1234 
  • close
  • closes
  • closed
  • fix
  • fixes
  • fixed
  • resolve
  • resolves
  • resolved

 

 템플릿

 

improve : #OOOO - OO 작업 기능 추가

2022-xx-xx
XX님의 요청으로 OO 작업 기능을 추가개발함
 * OOOO 개발
 * DB는 ~~ 참고
 * 문서 ~ 참고 
 * ....

resolved : #OOOO
see also : #XXX, #YYY, #ZZZ​

 

 

 

본 포스팅은 정답노트라기 보다는
경험과 생각을 정리한 낙서장입니다.