Programming

Commit Message Convention / 커밋 메시지 컨벤션

byolee 2020. 4. 3. 23:57

깃허브에 자주 커밋을 하게 되면서 언젠가 커밋 메시지를 정해야지 생각만 했다.

드디어 오늘 컨벤션을 정하고 그거대로 쓰려고 해야겠다.

 

해당 포스팅은 아래를 참고했습니다.

https://djkeh.github.io/articles/How-to-write-a-git-commit-message-kor/


규칙 1. 타이틀 첫 글자는 대문자로 시작하기

feat : @2#$$ -> Feat : ~ !3#$$

 

규칙 2. 시제 없이 명령문으로 작성하기 (동사원형)

Feats : @#$%% -> Feat : ~@#^^

 

규칙 3. 커밋 타입은 아래에 맞추어 작성하기

Feat : 코드나 테스트를 추가했을 때
Fix : 버그를 수정했을 때
Remove : 코드를 제거했을 때
Update : 코드보다는 문서나 라이브러리 등을 보완했을 때
Docs : 문서를 수정했을 때
Style : 코드 포맷팅에 대한 부분 변경, CSS 등
Rename : 이름을 변경했을 때
Move : 코드를 이동할 때
refac : 코드 리팩토링

 


계속 업데이트 할 예정..