[git] 좋은 commit message 작성하기

유명한 커밋 메시지 규칙

• How to Write a Git Commit Message
• AngularJS Git Commit Message Conventions

커밋 메시지

• 동명사보다 명사를 사용한다.
• 관사는 사용하지 않는다.
• 부정문 Don't 를 사용

커밋 메시지의 구조

<타입>[적용 범위(선택 사항)]: <설명>

[본문(선택 사항)]

[꼬리말(선택 사항)]

좋은 commit message를 위한 단어 목록

• Fix : 올바르지 않은 동작을 고친 경우에 사용
• Add : 코드나 테스트, 예제, 문서 등의 추가가 있을 때 사용
• Remove : 코드의 삭제가 있을 때 사용
• Use : 특별히 무언가를 사용해 구현을 하는 경우에 사용
• Refactor : 전면 수정이 있을 때 사용
• Simplify : 복잡한 코드를 단순화 할 때 사용
• Update : 개정이나 버전 업데이트가 있을 때 사용. (Fix와 달리 원래도 정상적으로 동작하고 있었지만 수정, 추가, 보완을 한다는 개념임에 주의) 코드보다는 주로 문서나 리소스, 라이브러리 등에 사용
• Improve : 향상이 있을 때 사용. 호환성, 테스트 커버리지, 성능, 검증 기능, 접근성 등 다양한 것들이 목적이 될 수 있음.
• Make : 주로 기존 동작의 변경을 명시
• Implement : 코드가 추가된 정도보다 더 주목할 만한 구현체를 완성시켰을 때 사용
• Revise : update와 비슷하나 문서의 개정이 있을 때 주로 사용
• Correct : 주로 문법의 오류나 타입의 변경, 이름 변경 등에 사용
• Ensure : 무엇이 확실하게 보장받는다는 것을 명시
• Prevent : 특정한 처리를 못하게 막음
• Avoid : 특정한 처리를 회피함. (ex. if 구문으로 특정한 동작을 제외시키는 경우)
• Move : 코드의 이동이 있을 때 사용
• Rename : 이름 변경이 있을 때 사용
• Allow : make 와 비슷하지만, 허용을 표현할 때 사용
• Verify : 검증 코드를 넣을 때 주로 사용
• Set : 변수 값을 변경하는 등의 작은 수정에 주로 사용
• Pass : 파라미터를 넘기는 처리에 주로 사용

 

 

출처

blog.ull.im/engineering/2019/03/10/logs-on-git.html www.conventionalcommits.org/ko/v1.0.0/#%ea%b0%9c%ec%9a%94