Commit message

커밋(Commit)은 프로젝트 시 파일의 변화가 있는 시점을 메시지와 함께 저장할 수 있는 기능이다.

커밋 메시지(Commit message)는 프로젝트를 효율적으로 관리하기 위해 작업단위를 구분할 수 있도록 도와준다.

 

커밋 메시지의 7가지 규칙

1. 제목과 본문을 빈 행으로 구분
2. 제목을 50글자 내로 제한
3. 제목 첫 글자는 대문자로 작성
4. 제목 끝에 마침표(.) 넣지 않기
5. 제목은 명령문으로 사용하며 과거형을 사용하지 않기
6. 본문의 각 행은 72글자 내로 제한
7. 어떻게 보다는 무엇과 왜를 설명하기

 

커밋 메시지 구조

<타입>[적용 범위(선택 사항)]: <설명>
    
[본문(선택 사항)]
    
[꼬리말(선택 사항)]

 

커밋 메시지 구성요소 (<타입>, 본문, 꼬리말)

build: 시스템 또는 외부 종속성에 영향을 미치는 변경사항 (npm, gulp, yarn 레벨)
ci: Continuous Integration ci구성파일 및 스크립트 변경
conf: configurations 환경설정 관련
★ chore: 패키지 매니저 설정할 경우, 코드 수정 없이 설정을 변경
design: 사용자 UI 디자인 변경
docs: documentation 문서 작업 변경
★ feat: feature 새로운 기능
★ fix: bug-fix 버그 수정
perf: performance 성능 개선
★ refactor: refactoring 버그를 수정하거나 기능을 추가하지 않는 코드 변경
★ style: 코드 의미에 영향을 주지 않는 변경사항 ( white space, formatting, colons )
test: 누락된 테스트 추가 또는 기존 테스트 수정
revert: 작업 되돌리기
rename: 파일 혹은 폴더명을 수정
remove: 파일을 삭제

가장 많이 사용 되는 것은 ★를 붙여주었다.

 

예시

feat: 유저 전체 조회 기능 추가
fix: update시 파라미터 수정

feat: Self-Type-Checking Types
fix: wrap the parameter of arrow function if needed
fix(Nav): add disabled style
chore(*): Release-1.24.5

 

---

참고

https://medium.com/humanscape-tech/%ED%9A%A8%EC%9C%A8%EC%A0%81%EC%9D%B8-commit-message-%EC%9E%91%EC%84%B1%EC%9D%84-%EC%9C%84%ED%95%9C-conventional-commits-ae885898e754

https://velog.io/@hustle-dev/Conventional-Commits%EC%97%90-%EA%B4%80%ED%95%98%EC%97%AC

https://nohack.tistory.com/17

https://beomseok95.tistory.com/328