코드를 작성해서 주석을 달거나 아니면, GitHub에 내 코드를 올릴때 Commit 메세지를 작성할 때 어려운 것중에 하나가 Naming이다.
코드를 작성할 때 규칙이 있듯이, Commit 메세지 또한 규칙이 있다고한다.
Commit 메시지 기본 규칙들
- 공통 규칙 : 메시지 본문에 변경 사항을 상세히 작성한다. (쉽게 이해하게끔)
- 커밋 메시지는 [제목, 본문, 꼬리말]로 구성된다.
- 각 구성은 공백의 라인으로 구분한다.
- 본문은 제목만으로 표현이 가능하면 생략한다.
- 꼬리말도 관련 이슈가 없으면 생략한다.
- 제목 첫 글자는 대문자로 작성한다.
- 제목에 마침표 넣지 않는다.
- 제목은 명령문으로 사용하며 과거형을 사용하지 않는다.
- 제목을 50글자 내로 제한한다.
- 본문은 72글자 단위로 줄바꿈을 시행한다.
- 본문을 통해 무엇을, 왜 등을 설명한다. (생략가능)
Commit 메시지 구조
$ <type>(<scope>): <subject> -- 제목
<BLANK LINE> -- 공백 라인
<body> -- 본문
<BLANK LINE> -- 공백 라인
<footer> -- 꼬리말Commit 메시지 타입 규칙
Feat : 새로운 기능에 대한 커밋
Build : 빌드 관련 파일 수정에 대한 커밋
Chore : 그 외 자잘한 수정에 대한 커밋
Ci : CI관련 설정 수정에 대한 커밋
Docs : 문서 수정에 대한 커밋
Form : 코드 형식, 정렬, 주석 등의 변경 커밋
Style : 코드 스타일 혹은 포맷 등에 관한 커밋
Test : 테스트 코드 수정에 대한 커밋
Release : 버전 릴리즈 커밋
Init : 프로젝트 생성 후 첫 커밋
예시
특정 이슈(#111)를 참조한 예시
Add: 알림 설정 ON/OFF 기능 추가(#111)
알림을 각각 ON/OFF 할 수 있도록 기능을 추가함
- push0022: 구분 코드
해결: close #111
개인 공부 및 기록겸 벨로그 시작