커밋 컨벤션 작성

Inyoung·2023년 9월 8일
0

오늘도 커밋 기여도를 채우기 위해 커밋 메시지를 작성하던 중..
나의 커밋 로그를 돌아보았다.

개인 프로젝트이긴 하지만 내가 봐도 작성한 나의 커밋 메시지를 이해하기 힘들었다... 협업을 할 때도 이렇게 하면 분명히 코드 유지보수와 가독성에 문제가 있을 거 같아 커밋컨벤션 작성법을 배우려고 한다.
유다시티의 커밋 메시지 스타일 가이드를 참조했다.

커밋 컨벤션의 구조

type: subject
(한 줄 띄어 분리하기)
body
(한 줄 띄어 분리하기)
footer

구조 자체는 굉장히 간단하다!

기본적으로 제목, 본문, 꼬리말 세가지로 나뉘며 줄 바꿈을 통해 구분한다.

type 에 올 것

feat: 새로운 기능 추가할 때
fix: 버그 수정
docs : 문서 수정
style : 코드 변경이 없을 때, 세미콜론 추가하거나 코드 포맷팅 시
refactor : 코드 리팩토링
test : 테스트 코드 , 리팩토링 테스트 코드 추가
chore : 빌드 업무 추가 , 패키지 매니저 수정

subject

간결하게 커밋 내용을 요약하는 느낌.

body

최대한 자세하게 적기. 무엇을 왜 변경했는지 설명 ㄱㄱ

optional. 선택사항 issue tracker ID를 명시하고 싶은 경우 사용. 이슈 트래커 유형은 다음과 하나로 작성

Fixes: #1 (아직 고치는중)
Resolves: #1 (해결완료)
Ref: #1 (참고할 이슈)
Related to: #1 (해당 커밋과 관련된 이슈번호)

profile
겸손한 태도로 자아실현하기

0개의 댓글