안녕하세요
오늘은 Git 커밋 메시지에 대하여 적어보려고 합니다.
프로젝트를 진행하다 보면 여러 사람들과 협업해야 할 때가 있는데요.
커밋 메시지를 보며 버전 관리와 동료들이 무엇을 했는지 등 한눈에 알 수 있습니다.
추가로 다음과 같은 효과들이 있습니다.
* 더 좋은 커밋 로그 가독성
* 더 나은 협업과 리뷰 프로세스
* 더 쉬운 코드 유지보수
회사마다 커밋 메시지의 규칙은 다르겠지만,
이번에 소개해드릴 내용은 보편적으로 사용하는 규칙입니다.
커밋 규칙
<type>(<scope>): <subject> // 제목
<blank line>
<body> // 본문
<blank line>
<footer> // 푸터커밋 메시지의 기본적인 구조입니다.
제목은 필수이고, 본문과 푸터는 선택사항입니다.
제목과 본문은 아래와 같은 규칙이 있습니다.
- 제목과 본문을 한 줄 띄워 분리
- 제목은 영문 기준 50글자로 제한
- 제목 첫 글자는 대문자로 작성
- 제목 끝에 . 금지
- 제목은 명령문으로 작성
- 본문은 영문 기준 62글자로 제한
- 본문은 "어떻게"보다 "무엇을", "왜" 형식으로 작성
타입에도 규칙이 있습니다.
- Feat : 새로운 기능 추가
- Fix : 버그 수정
- Docs : 문서 수정
- Style : 코드 스타일 & 포맥 관련
- Refactor : 코드 리팩터링
- Test : 테스트 코드 수정/추가
- Chore : 빌드 업무, 패키지 매니징, 그 외 사소한 수정
'Others > Git' 카테고리의 다른 글
| [Git] Please enter a commit message to explain why this merge is necessary, especially if it merges an updated upstream into a topic branch (0) | 2022.02.05 |
|---|---|
| Git 기본적인 명령어 간단 정리 (0) | 2022.02.04 |