[GitHub] 커밋 컨벤션을 알아보자

코드 작업을 하고 깃허브에 푸시하기 전에 우리는 커밋 메시지를 작성합니다.

# Bad: 커밋 메시지에 의미가 없다
git commit -m "버그 수정"

# Bad: 커밋 메시지가 너무 길다
git commit -m "사용자가 인증 요청을 보내면 사용자에게 인증 번호를 문자로 전송하는 기능 추가"

저는 처음으로 프로젝트에 참여했을 때는 대체로 이런식으로 커밋을 했습니다.
하지만 이런 식의 커밋은 히스토리를 봐도 변경사항을 파악하기 힘들고 팀원들도 제가 무슨 작업을 했는지 명확히 알 수 없었습니다.

이를 개선하기 위해 도움이 됐던 방법을 적어보고자 합니다.

---

커밋 메시지 템플릿

가장 먼저 커밋 메시지 구조를 구성하는 것입니다.

type: 제목

body (옵션)

footer (옵션)

여기서 type은 커밋의 종류를 나타내며, 주로 다음과 같이 사용됩니다.

타입	의미
feat	새로운 기능 추가
fix	버그 수정
docs	문서 수정
style	코드 포맷팅 변경
refactor	코드 리팩토링
test	테스트 코드 추가
chore	빌드 작업, 패키지 매니저 수정

 

body는 긴 설명이 필요할 때 추가합니다.

feat: 회원가입 유효성 검사 추가

- 이메일 형식 검사 추가
- 비밀번호 최소 8자 이상 검사
- 특수문자 포함 여부 검사

 

footer는 이슈 번호를 작성하거나 브레이킹 체인지를 기록할 때 사용합니다.

feat: API 응답 형식 변경

BREAKING CHANGE: API 응답 형식이 변경되었습니다.
Fixes: #123

 

그 외에도

작은 단위로 커밋을 하면 커밋 메시지 작성이 쉬워졌고
다양한 개발 동아리의 깃헙을 방문해서 참고하는 것도 도움이 됐습니다.

---

지키기 어려울 수도 있지만 제 코드를 다른 개발자들이 이해할 수 있다는 게 가장 큰 장점인 것 같습니다.

글을 끝까지 봐주셔서 감사합니다.
틀린 내용이 있다면 댓글 부탁드립니다.