.gif&blockId=743d12a5-f17c-4b91-a76d-8a3aa6fd4c06)
1. 커밋 유형 지정
•
커밋 유형은 영어 대문자로 작성하기
커밋 유형 | 설명 |
Feat | 새로운 기능, 특징 추가 |
Fix | 수정, 버그 수정 |
Docs | 문서에 관련된 내용, 문서 수정 |
Style | 스타일링 |
Refactor | 리팩토링 |
Test | 테스트 코드 수정, 누락된 테스트를 추가할 때, 리팩토링 테스트 추가 |
Chore | 빌드 업무 수정, 패키지 매니저 수정 |
2. 제목 끝에 이슈 번호 연결
•
ex) Feat: 로그인 기능 구현 #13
3. 제목과 본문을 빈행으로 분리
•
커밋 유형 이후 제목과 본문은 한글로 작성하여 내용이 잘 전달될 수 있도록 할 것
•
본문에는 변경한 내용과 이유 설명 (어떻게보다는 무엇 & 왜를 설명)
4. 제목 첫 글자는 대문자로, 끝에는 . 금지
5. 여러가지 항목이 있다면 글머리 기호를 통해 가독성 높이기
- 변경 내용 1
- 변경 내용 2
- 변경 내용 3
Plain Text
복사
규칙에 맞는 좋은 커밋메시지를 작성해야 하는 이유
•
팀원과의 소통
•
편리하게 과거 추적 가능
•
나중에 실무에서 익숙해지기 위해
안지킨 사례
지킨 사례
한 커밋에는 한 가지 문제만!
•
추적 가능하게 유지해주기
•
너무 많은 문제를 한 커밋에 담으면 추적하기 어렵다.
CLI에서 커밋 메시지 여러 줄로 작성하는 방법
쌍따옴표를 닫지 말고 개행하며 작성 → 다 작성한 후에 쌍따옴표를 닫으면 작성 완료
git commit -m "FEAT: 회원가입 기능 추가
- 회원가입 기능 추가"
Bash
복사
