[ Git ] Git 컨벤션

GIt 커밋 메시지는 아래와 작성합니다.

type subject [[(issue num)] | 

body
...
...

footer [(issue num)]

]

 

예를 들어 다음과 같습니다.

# body 를 작성하지 않을 경우
♻️ 메인 소스 코드 리펙토링

# body 를 작성하지 않은 이슈 대응 작업
🚑️ 핫픽스 대응 (#215)

# body를 작성하는 경우
🐛 버그 발생 대응

메인 엑티비티 발생 에러
- activity_main.xml 의 내용 삭제

Closes

# body를 작성한 이슈 대응 작업
✨ 회원가입 기능 추가

로그인 액티비티 회원가입 기능 추가
- activity_login.xml 의 회원가입 추가

Closes (#241)

 

Git 커밋에 사용되는 문구의 타입은 아래의 이모지를 사용합니다.

이모지명	표시	설명
:recycle:	♻️	코드 리펙토링
:bug:	🐛	버그 발생 수정
:sparkles:	✨	새로운 기능 추가
:memo:	📝	문서를 추가 및 수정
:lipstick:	💄	UI 및 스타일 파일 추가 및 수정
:zap:	⚡️	성능 개선
:white_check_mark:	✅	테스트를 추가
:construction_worker:	👷	빌드 시스템 추가 및 수정
:lock:	🔒️	보안 문제 수정
:tada:	🎉	프로젝트 시작
:ambulance:	🚑️	핫픽스 수정
:fire:	🔥	코드 및 파일 제거
:art:	🎨	코드 구조/형식 개선
:construction:	🚧	진행중인 작업
:truck:	🚚	리소스 이동 및 이름 변경
:bulb:	💡	소스 코드 주석 추가
:loud_sound:	🔊	로그 추가 및 수정
:mute:	🔇	로그 삭제
:coffin:	⚰️	데드 코드 삭제

 

Git 브랜치 명은 다음과 같이 작성합니다.

브랜치	용도
main	제품 출시/배포
develop	다음 출시/배포를 위한 개발 진행
release	출시/배포 전 테스트 진행(QA)
feature	기능 개발
hotfix	긴급한 버그 수정

 

※ 깃 브랜치명 컨벤션 가이드 : https://nvie.com/posts/a-successful-git-branching-model/

※ 깃 이모지 가이드 사이트 : https://gitmoji.dev/

※ 깃 이모지 사용 예 사이트 :  https://github.com/carloscuesta/gitmoji