Git Convention | Git으로 팀프로젝트 협업하기

보기 좋은 커밋 메시지는 당신의 시간을 단축해줍니다.

혼자 개발할 때는 알 수 없지만 협업을 하는 순간 커밋 메시지를 읽는 작업은 중요해진다.

그런데 커밋 메시지가 

file 수정

이렇게만 적혀있다면?...

뭐가 어떻게 수정됐는지 파일을 눌러봐야만 알 수 있다...

이것은 많은 사람들의 스트레스를 유발하므로!

꼭! 

프로젝트 시작 전에 개발 인원끼리 커밋 메시지 규칙을 정하도록 하자

 

아래는 현재 진행중인 팀 프로젝트에서 사용하는 커밋 메시지 규칙이다.

<타입> : #이슈번호 - <제목> 형식으로 작성하며 제목은 최대 50글자 정도로만 입력
제목 끝에 마침표 금지, 무엇을 했는지 명확하게 작성
################
본문(추가 설명)을 아랫줄에 작성
################
꼬릿말(footer)을 아랫줄에 작성 
################
#Feat: 새로운 기능을 추가할 경우
#Fix: 버그를 고친 경우
#DesignCSS: 등 사용자 UI 디자인 변경
#!BREAKING: CHANGE|커다란 API 변경의 경우
#!HOTFIX: 급하게 치명적인 버그를 고쳐야하는 경우
#Style: 코드 포맷 변경, 세미콜론 누락, 코드 수정이 없는 경우
#Refactor: 프로덕션 코드 리팩토링
#Comment: 필요한 주석 추가 및 변경
#Docs: 문서를 수정한 경우
#Test: 테스트 추가, 테스트 리팩토링(프로덕션 코드 변경 X)
#Chore: 빌드 테스트 업데이트, 패키지 매니저를 설정하는 경우(프로덕션 코드 변경 X)
#Rename: 파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
#Remove: 파일을 삭제하는 작업만 수행한 경우
################

 

이렇게만 보면 이해가 잘 안 갈 수 있어서(내가 그랬음) 예시를 첨부한다!

//이슈 345번, 회원 가입시 닉네임 중복 체크 로직을 추가함
Feat: #345 - 회원 가입시 닉네임 중복 체크 로직을 추가

//이슈번호 없이 급하게 버그를 고쳐야함, 잘못 작성된 url 수정
!HOTFIX: 잘못 작성된 url을 ~~~로 수정

 

Git Convention

그 밖에 팀프로젝트를 하며 유용하게 써먹은 Git 사용법을 Wiki에 정리해두었다.

팀프로젝트 Git 협업이 처음이라면 참고해보자!

https://github.com/duck-map-project/duck-map-be/wiki/Git-Convention

Git Convention