협업을 위한 git 커밋 컨벤션에 대해 알아보자!
git 커밋 메시지는 코드 변경 사항을 요약하여 전달하는 역할을 한다.
커밋 컨벤션을 몰라도 아래의 예시처럼 commmit은 가능하다.
하지만 본인만 이해할 수 있고 어떤 내용이 변경 되었는지 알 수 없다. 가독성이 떨어짐!
협업을 진행할 때 여러명의 개발자가 본인만의 커밋 메시지를 쓴다면 소통에 불편함이 있을 것이다.
Commit Convention이란?
커밋 메시지에 대한 약속, 작성하기 위한 규칙이다. 정해진 규칙에 따라 커밋 메시지를 씀으로써 여러명의 개발자가 서로의 작업을 파악할 수 있고, 효율적이고 안정적인 관리가 가능하다.
커밋 메시지 구조는 3가지로 구성하고 각 파트는 빈줄로 구분한다.
type: Subject -> 제목
body -> 본문
footer -> 꼬리말
1. type
type = tag(태그) + subject(제목)
태그는 영어로 쓰며 첫 문자는 대문자로 적어야 한다.
자주 사용하는 태그
- Feat : 새로운 기능을 추가하는 경우
- Fix : 버그를 고친 경우
- Style : 코드 포맷 변경, 세미콜론 누락, 코드 수정이 없는 경우
- Docs : 문서 수정
- Refactor : 코드 리펙토링
- Test : 테스트 코드, 리펙토링 테스트 코드를 추가했을 때
- Chore : 빌드 업무 수정, 패키지 매니저 수정했을 때
- Design : CSS등 사용자가 UI 디자인을 변경했을 때
- Rename : 파일명|폴더명을 수정한 경우
- Remove : 코드(파일)의 삭제가 있을 때.= Clean, Eliminate
- init : 프로젝트 초기 생성
제목
코드 변경 사항에 대해 짧은 요약
- 최대 50자
- 과거형 X, 명령조 O
- 첫 글자 대문자
- 마침표, 특수기호 X
- 간결하게!!
2. body
- 한 줄당 최대 72자
- 무엇을, 왜 변경했는지 작성
- 상세하게!!
3. footer
이슈 트래커 유형:#이슈 번호
issue tracker id를 작성할 때 사용
issue tracker 유형
- Fixes : 이슈 수정중 (아직 해결되지 않은 경우)
- Resolves : 이슈를 해결했을 때 사용
- Ref : 참고할 이슈가 있을 때 사용
- Related to : 해당 커밋에 관련된 이슈번호 (아직 해결되지 않은 경우)
커밋 메시지 작성해보기
Feat: Add login API
로그인 API 개발
Resolves: #123
!!