이때까지 필자는 Git 커밋 메시지를 개판으로(내멋대로) 써왔다.
언제 한번 나도 깔끔한 커밋메시지를 작성해보자 생각은 했었다.
협업을 하기위해 꼭 필요한 과정이기때문에 미리 정리를 해두려고 한다.
🤷🏻♀️ 왜 좋은 커밋메시지를 작성해야 하는데?
-
팀원과의 소통
-> 규칙에 맞는 커밋메시지를 작성하게 되면 팀원의 메시지를 이해하기 더 쉽고 편하다. -
편리한 과거 기록 추적
-> 가끔 과거의 코드가 필요할 때가 있다. 어느 시점으로 돌아갈지는 커밋메시지를 보고 판단하기 때문에 잘 정리된 커밋메시지가 필요하다.
👉🏻 커밋 유형 지정
- Feat: 새로운 기능 추가
- Add: Feat 이외의 코드 or 라이브러리 or View, Activity 추가
- Fix: 버그 수정
- Design: UI 변경
- Style: 스타일 관련 기능 (오타 수정, 변수명 변경, 코드 자체에는 변경이 없는 경우)
- Docs: 문서 수정 (README.md 수정)
- Chore: 빌드 관련 파일, 패키지 매니저 수정 (.gitignore or build.gradle) - 프로덕션 코드 변경 x
- Comment: 주석 추가 및 변경
- Remove: 파일, 폴더 삭제
- Rename: 파일, 폴더명 수정
- !BERAKING CHANGE: 커다란 API 변경 (ex: API arguments, return 값 변경, DB 테이블 변경, 치명적 버그 수정)
- !HOTFIX: 치명적 버그 수정
- Refactor: 코드 리펙토링
- Test: 테스트 코드 추가 및 수정 - 프로덕션 코드 변경 x
- Ci: CI 관련 설정 수정
🙏🏻 7가지 규칙
- 제목과 본문을 빈 행으로 구분
- 제목은
50글자이내로 제한 - 제목 첫 글자는
대문자로 작성 - 제목 끝에 마침표 넣지 않기
- 제목은
명령문을 사용하며 과거형을 사용하지 않음 - 본문의 각 행은
72글자내로 제한 어떻게보단무엇과왜를 설명
일단 위 규칙대로 사용해보고 추후에 더 필요한 규칙은 추가할 것이다.
유잼코딩