git
[Git] - git commit message
deep__sea
2022. 2. 4. 19:31
728x90
Commit message 포맷
<type>(<scope>): <subject> // 타입 / 범위(optional) / 제목
<body> // 본문(optional)
<footer> // 꼬리말(optional)
Git commit [Type]
| Commit Type | 역할 | 비고 |
| feat | 새로운 기능 | |
| fix | 버그 수정 | |
| build | 빌드 파일 수정 | |
| chore | 그 외 자잘한 수정 | gitignore, package manager 등 |
| ci | CI 설정 파일 수정 | |
| docs | 문서 파일 수정 | |
| style | 코드 수정 없이 코드 포맷, 세미 콜론 누락 수정 |
|
| refactor | 코드 리팩토링 | |
| test | 코드 수정 없이 테스트 코드 추가 및 리팩토링 테스크 코드 추가 | |
| design | UI 디자인 변경 | CSS, inline style 등 |
| rename | 파일 혹은 폴더명 수정 | |
| remove | 파일 삭제 |
다음은 작성 예시이다!
feat : Add someting
This is...작성하기 나름이다. 나는 "feat : " 이렇게 타입을 작성했지만 다른 기업이나 개발자는 "[feat]" 과 같이 작성하는 경우도 있다.
커밋 메시지는 어느 것이 정답이라고 할 수 없다. 하지만 어느 누가 읽어도 이해는 가능해야 하고, 메시지를 통해 서로 소통이 될 수 있어야 한다.
그리고 작성시 이것만은 최소한으로 지키자!
1. 제목과 본문을 분리하자
2. 제목을 간결하게 작성하자 (50자 이내)
3. 제목 첫 글자는 대문자로 작성하자(태그를 말한 것이 아니다)
4. 제목 끝에 마침표를 넣지 말자
5. 제목은 명령문 형태로 작성하자
6. 본문은 변경 사항에 대한 설명을 적도록 하자
7. 변경 사항이 복잡할 경우 본문을 여러 줄로 나눠서 작성하자
너무 성의 없이 작성하지 말고 최소한으로 지켜야할 부분은 지키면서 작성하자!
만약 동료 중에 제대로 작성하지 않아 깃 히스토리의 메시지의 규칙이 깨진다면 뒤에 남들 모르게 살짝 쿵 알려주자ㅎ(절대 악의 없이)
참고
728x90
반응형