기본적인 커밋 메세지 구조

[<목적>[(<범위>)]: ]<제목> #<이슈No>

말머리에는 커밋 목적과 범위를 적는다

1. 커밋 목적
   • Set 개발환경 셋업, 변경, 라이브러리 추가 등
   • Add 없던 기능의 추가
   • Update 있던 기능의 사양변경
     • 입력변수 추가, 출력변수 추가도 기능의 사양변경이라는 점을 주의할 것
   • Fix 오작동 하는 기능의 오류해결
   • Deprecated 안쓰는 기능 제거
   • Hotfix 긴급히 적용해야 하는 심각한 오류 해결
   • temp 임시 저장용 커밋
   • Refactor 코드 구조 변경
   • Docs 프로젝트 관련 문서
   • CSS css 수정
   • Chore 자잘한 작업
2. 커밋 범위 CamelCase로 적는다
   • all 전역
   • [<dirName>] 영향받는 디렉토리 범위 이름
   • [<className>] 영향받는 클래스 이름
   • [<functionName>] 영향받는 전역함수의 이름
   • etc..

이슈가 존재하는 커밋은 첫줄 마지막에 이슈번호(#no)를 적는다.

커밋 요약을 적는다

• 명사형으로
• 50자 이내로 적는다
• 커밋의 대상, 커밋의 목적은 항상 명확해야 한다
• 한 커밋은 하나의 목적만 담는다

단순 문법 수정, 주석 추가는 .을 찍어도 된다

예) (result) => {res.send(result)}
> result => res.send(result) // send User Data

하지 말아야 하는 것

• 코드 변경과 문법 변경을 동시에 커밋 하지 않는다

결과

1. [set] 보일러 플레이트
2. Docs(Readme): README.md
3. Docs(Sql): userTable
4. Add(Signup): 회원가입 #1
5. Add(Signin): 로그인 #1
6. Fix(Signup): 회원가입 이메일 validate #1
7. Todo(Board): 게시판 리스트 #2
8. Update(User): 회원 속성 '문자수신동의' 추가 #1
9. Add(Logout): 로그아웃 #1
10. Todo(Goods): 제품추천 #3
11. Add(Board): 게시판 리스트 #2
12. Set(All): 'node-mailer'
13. .
14. Add(UserDetail): 회원정보 #1
15. Fix(Logout): 로그아웃 #1
16. Add(GoodsReco): 제품추천 #3

참고문서

Git 커밋 메시지 작성법

커밋 메시지에 대해

Karma - Git Commit Msg

Git을 이용하여 텔레파시 통하는 팀 만들기

커밋 로그 조작