hrming

[기타] Commit Message 본문

기타

[기타] Commit Message

hrming 2024. 3. 5. 18:11

Share Book 프로젝트 진행하면서, 커밋 메세지를 아래 처럼 통일시키기. 🤗✨

 

기본 규칙

- 제목과 본문을 빈 행으로 구분

- 제목은 영문 기준 50글자 이하

- 첫 글자는 대문자로 작성

- 제목 끝에 마침표X

- 제목은 명령문으로 사용, 과거형X

- 본문의 각 행은 영문 기준 72글자 이하

- 어떻게 보다는 무엇과 왜

 


타입별 키워드

Type 키워드 사용 시점
feat 새로운 기능 추가
fix 버그 수정
docs 문서 수정
style 코드 스타일 변경 (코드 포매팅, 세미콜론 누락 등)
기능 수정이 없는 경우
design 사용자 UI 디자인 변경 (CSS 등)
test 테스트 코드, 리팩토링 테스트 코드 추가
refactor 코드 리팩토링
build 빌드 파일 수정
ci CI 설정 파일 수정
perf 성능 개선
chore 빌드 업무 수정, 패키지 매니저 수정 (gitignore 수정 등)
rename 파일 혹은 폴더명을 수정만 한 경우
remove 파일을 삭제만 한 경우

 


출처 및 참고 :

https://jane-aeiou.tistory.com/93

 

[Git] 좋은 commit message 작성법

좋은 Git Commit Message 작성 가이드라인 Commit Message 평소 커밋 메세지 자세하게 잘 쓰고 있다고 생각했는데, 더 깔끔한 가이드라인이 있어 공유하고자 가져왔습니다. 기존 커밋은 "[카테고리] 개발

jane-aeiou.tistory.com

 

'기타' 카테고리의 다른 글

[기타] Code Refactoring  (1) 2024.03.06
[기타] CSR & SSR  (0) 2024.03.06
[기타] Maven  (1) 2024.03.05
[기타] Google Font  (0) 2024.03.02
[Sublime Text] 일괄 수정 기능  (0) 2024.01.30
Comments