[Conventional Commits] 커밋 메시지 작성 가이드

https://www.conventionalcommits.org/en/v1.0.0/

Conventional Commits

 

중구난방으로 커밋메시지를 정리했는데,

프로젝트 관리를 위해 커밋 메시지를 체계적으로 정리할 필요를 느꼈다.

 

커밋메시지의 기본 템플릿은 다음과 같다.

[타입]: [간단한 설명]

 

예를 들어 다음과 같은 커밋 메시지가 존재할 수 있다.

feat: 회원가입 기능 추가
fix: 이미지 업로드 오류 수정
docs: README 파일 업데이트

 

처음 커밋 메시지를 작성할 때는 나중에 뭘 했는지 확인하려고

메시지 내용을 엄청 길게 작성했던 기억이 있다(...)

 

우연찮게 다른 사람의 코드를 본 적이 있었는데,

엄청 간단하게 작성해서 놀랐다.

 

그 날의 경험을 바탕으로 정리한 커밋 메시지의 고려사항은 다음과 같다.

1. 간결하고 명확한 커밋 메시지
2. 타입을 사용한 목적 구분

fix	버그를 수정할 때 사용	fix: 이미지 업로드 오류 수정
feat	새로운 기능을 추가	feat: 회원가입 기능 구현
build	빌드 관련 파일이나 설정 수정	build: webpack 설정 추가
chore	빌드 업무, 패키지 매니저 설정 등 자잘한 작업	chore: .gitignore 파일 업데이트
ci	CI 설정 파일 수정에 사용	ci: GitHub Actions 워크플로 수정
docs	문서를 수정할 때 사용	docs: API 문서 업데이트
style	코드의 스타일/형식 변경에 사용(기능상 변화는 없음)	style: 코드 포매팅 수정
refactor	코드 리팩토링 작업	refactor: 로그인 로직 리팩토링
perf	성능을 개선하기 위한 코드 변경에서 사용	perf: 쿼리 최적화
test	테스트 코드를 추가하거나 수정할 때 사용	test: 회원가입 기능 유닛 테스트 추가