[Git] 커밋 메시지 컨벤션 (Udacity Git Commit Message Style Guide)

Git 커밋 메시지 컨벤션

• 커밋 메시지를 잘 작성하는 것은 협업하는데 있어 중요하다.
• 유다시티에서는 Git Commit Message Style Guide를 제공하고 있다.
• 먼저 커밋 메시지는 제목(subject), 본문(body), 꼬리말(footer) 3가지 파트로 나누고, 각 파트는 빈 줄을 두어 구분한다.

type: Subject (제목)

body (본문)

footer  (꼬리말)

• type: 어떤 의도로 커밋했는지를 type에 명시. Udacity에서는 타입을 다음 7개 중 하나로 쓸 것을 권장
  • feat: 새로운 기능을 추가할 경우 사용한다.
  • fix: 버그와 같은 것을 수정했을 때 사용한다.
  • docs: 문서와 관련하여 수정한 부분이 있을 때 사용한다.
  • style: 코드의 변화와 관련없는 코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우 사용한다.
  • refactor: 새로운 기능이나 버그 수정없이 코드의 리팩토링을 의미한다.
  • test: test를 추가하거나 수정했을 때를 의미한다.
  • chore: build와 관련된 부분, 빌드 태스크 업데이트, 패키지 매니저 설정 등 여러가지 production code와 무관한 부분들을 의미한다.
• subject:최대 50글자가 넘지 않도록 작성하고 마침표는 찍지 않음. 영문으로 표기하는 경우 동사(동사원형)를 가장 앞에 두고 첫글자는 대문자로 표기함
• body: 긴 설명이 필요한 경우에 작성함. 어떻게 했는지가 아니라, 무엇을 왜 했는지를 작성함. 최대 75자를 넘기지 않음
• footer: issue tracker ID를 명시하고 싶은 경우에 작성
• 커밋 메시지 작성 예시

Feat: 추가 로그인 함수

로그인 API 개발

Resolves: #123  
Ref: #456  
Related to: #48,, #49