신입 시절 4명의 프론트엔드 팀으로 이루어진 조직에서 첫 번째로 했던 일은 커밋 컨벤션부터 만드는 것이였다. 누가 시켰다기 보다는 아무런 규칙조차 없이 제로베이스의 개발자 4명이 협업을 해야했기 때문이다.
이번 노션 블로그를 만들면서 혼자 작업을 하게 되니 커밋을 잘 나누지 않고 키워드나 설명이 다소 부족해지는 걸 느끼는 찰나 티스토리 블로그 이웃 분께서 커밋 컨벤션에 대해 글을 잘 써주셔서 나름 참고해 보며 회사에서 정한 컨벤션과 결합을 해봤다.
git commit 컨벤션 키워드로 검색을 하면
Type 부분만 조금씩 다르고 대체로 비슷한 경우가 많았는데, 조직마다 다른 방식의 컨벤션을 사용할 수 있지만 대체로 비슷해보인다.📌 Commit Rules
1. 제목을 50글자 내로 제한
2. 제목 끝에 마침표 넣지 않음
3. 어떻게 보다는 무엇과 왜를 설명
📌 Commit Convention
Type | Description |
Feat | 새로운 기능의 추가 |
Comment | 주석 작성 |
Fix | 버그 수정 |
Design | UI 디자인 변경 |
Style | 단순 CSS 스타일 수정 |
Refactor | 코드 리팩토링 |
Docs | 문서 및 Readme 작성 및 수정 |
Test | 테스트 코드 작성(테스트 코드 변경 X) |
Chore | 소스 코드르 건들지 않는 작업(빌드 테스트 업데이트, 패키지 매니저 설정 등) |
Init | 첫 프로젝트 초기화 |
CI | CI 관련 설정 |
Build | 빌드 관련 파일 수정 |
Rename | 파일/폴더명 수정 및 옮기는 작업 |
Remove | 파일을 삭제하는 작업 |
📌 Commit 메세지 구조
<type>(<scope>): <subject> -- 헤더
<BLANK LINE> -- 빈칸
<body> -- 본문(선택)
scope는 선택적으로 코드가 변경되는 범위를 뜻합니다. 컴포넌트 단위가 될 수 있습니다.
📌 Commit 예시
Docs(readme): 프로젝트 소개 및 규칙 작성
Design(PostList): UI 수정
까먹을 때 마다 보면서 잘 작성하자!
