과제제출후 커밋메세지로만 어떤 기능이 구현되었는지 보기 힘들다는 피드백을 받음.
커밋 메세지 컨벤션을 추천해주셨다.
Commit Convention
깃허브에 커밋을 할때 커밋 메세지에 작성할때의 규칙,약속
git commit 실행후 편집
사용하는 이유
-
가독성 향상 : 일관된 형식의 커밋로그는 빠르고 쉽게 이해할 수 있어서
협업시 변경 사항에 대한 이해도를 높여줌. -
유지보수의 향상 : 일관된 커밋 메세지를 통해, 특정 기능이나 수정한부분을
빠르게 파악가능해 쉽게 롤백 가능
기본구조
<Type>(<Scope>): <Subject> //제목
공백
<Body> //본문
공백
<Footer> //추가말
단락소개
Type
커밋의 유형을 나타내는 곳.
- feat : 새로운 기능을 추가할 때 사용
- fix : 버그를 수정할 때 사용
- docs : 문서만 변경했을 때 사용
- style : 코드 포맷, 세미콜론 누락 등 코드의 의미에 영향을 주지 않는 변경 사항에 사용
- refactor : 코드 리팩토링을 할 때 사용
- test : 테스트 추가 또는 기존 테스트 수정에 사용
- chore : 빌드 작업, 패키지 매니저 설정 등 기타 변경 사항에 사용
Scope
커밋이 영향을 미치는 모듈이나 컴포넌트
Body
커밋의 상세한 설명을 기술.
각 줄은 보통 72자 이내로 작성.
'무엇'을 변경했고 '왜' 변경했는지 설명. '어떻게'는 가능한 간략하게
Footer
추가적인 정보나 이슈 트래거 ID등을 서술.
*Fixes: #1 이라고 가정
- Fixes : Fixes: #1 이슈 수정중
- Resolves : Resolves: #1 이슈를 해결한 경우
- Ref: Ref: #1은 해당 커밋이 이슈 #1을 참조하고 있는경우
- Related to: Related to: #1, #2는 해당 커밋이 이슈 #1 및 #2와 관련있지만
해결된 것은 아님
나만의 템플릿 만들기
-
커밋 메시지 템플릿 파일 생성
커밋 메시지를 작성할 때 따르고 싶은 구조나 가이드라인을 포함한
커밋 메시지 템플릿을 정의한후 .txt로 생성. -
Git에 템플릿 파일 경로 설정
git config --global commit.template <템플릿 파일 경로/파일명> -
git commit 실행시 설정한 템플릿 내용이 편집기에 자동으로 로드 =>
일관된 형식으로 작성가능
엉덩이가 무거운 사람