chanjunpark / today-i-learn

Today I Learn(TIL)
0 stars 0 forks source link

[Git] Commit Convention - 커밋 메시지를 체계적으로 관리하기 위한 방법 #5

Closed chanjunpark closed 2 years ago

chanjunpark commented 2 years ago

Git의 기본적인 Commit Convention과 사용사례에 대해 조사해보자

chanjunpark commented 2 years ago

Commit 메시지 구조

유형  :  제목

본문

꼬리말

Commit 유형

feat : 새로운 기능 추가 fix : 버그 수정 docs : 문서 수정 style : 코드 포맷팅(코드변경이 없는 경우) refactor : 코드 리팩토링 test : 테스트 코드 chore : 빌드수정, 패키지수정

제목

제목은 50자를 넘기지 않고, 마침표를 붙이지 않는다 개조식으로 작성? (과거 시제의 서술형 지양)

본문(선택)

제목과 구분하기 위해 한 칸 띄어서 작성 제목에 대한 부연설명 등이 필요한 경우 작성

꼬리말(선택)

JIRA 티켓 번호 등 이슈버전을 명시(존재하지 않는 경우 안 써도 무방함)

resolve : JIRA-111 reference : JIRA-112, JIRA-113

작성예시

feat  :  댓글 알림 기능 추가

- 새로운 댓글 생성 시 게시글 작성자에게 알려줌
- x.xx 스펙 반영 예정

해결 : PROJECT - 100

참고자료

Udacity Git Commit Message Style Guide