Commit Message Convention

Commit Message Convention

Commit 메시지 구조

기본 적인 커밋 메시지 구조는 제목,본문 두 가지 파트로 나누고, 각 파트는 빈줄을 두어 구분한다.

type : subject

body

• type은 영어로, subject는 한글로 작성한다.
• body는 필수로 들어가되, 내용은 작성하지 않아도 된다.

💡Commit Type

타입은 태그와 제목으로 구성되고, 소문자로 작성한다.
태그: 제목의 형태이며, :뒤에만 space가 있음에 유의한다.

• feat : 새로운 기능 추가
• fix : 버그 수정
• docs : 문서 수정
• style : 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우
• design : css 변경이 있을 때
• refactor : 코드 리펙토링
• test : 테스트 코드, 리펙토링 테스트 코드 추가
• chore : 빌드 업무 수정, 패키지 매니저 수정

type이 헷갈린다면 팀원들에게 물어보기

📫Subject

• 제목은 최대 50글자가 넘지 않도록 하고 마침표 및 특수기호는 사용하지 않는다.
• 개조식으로 메시지를 작성한다. (e.g. 로그인 기능 구현)
• 파일 이름 혹은 코드가 들어갈 경우 파일 이름 과 같이 백틱 처리(``)하여 표기한다.

📌🔗Body(option)

Subject 만으로 내용 전달이 어려울 때, 이해를 돕기 위해 작성한다.(부연설명)

• 개조식으로 메시지를 작성한다.
• Subject와 달리, 파일 이름 혹은 코드가 들어갈 경우 백틱 처리(``)하지 않는다.
• 본문은 한 줄 당 72자 내로 작성한다.
• 본문 내용은 양에 구애받지 않고 최대한 상세히 작성한다.
• 본문 내용은 어떻게 변경했는지 보다 무엇을 변경했는지 또는 왜 변경했는지를 설명한다.

Commit 예시

feat: 회원 가입 기능 구현 

SMS, 이메일 중복확인 API 개발