Git Commit Convention

필요성

여러 명의 개발자가 함께 코드를 구현하고 여러 작업물들을 관리하게 된다.
여기서 각 팀원들의 커밋 내역을 명시적으로 확인 가능하고,
쉽게 관리될 수 있도록 하기 위한 메시지 규약이다.

Commit 메시지구조

• 타입 : 제목

• 본문

• 꼬리말
  
  

제목, 본문, 꼬리말 세파트로 나누며, 각 파트는 빈줄로 구분한다.

1. 커밋 타입

타입은 태그와 제목으로 구성된다. 영어로만 쓰며, 첫 문자를 대문자로 표기한다.

태그: 제목

• Ci : CI 구성 파일 및 스크립트에 대한 변경사항
• Feat : 새 기능 추가
• Fix : 버그 수정
• Docs : 문서 수정
• Perf : 성능을 향상시키는 코드 변경
• Style : 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우
• Refactor : 코드 리펙토링
• Test : 테스트 코드, 리펙토링 테스트 코드 추가
• Chore : 빌드 업무 수정, 패키지 매니저 수정

예시

Feat: Add validating API

Fix: Fix API argument passing issue

2. 제목

제목은 최대 50자, 마침표 및 특수기호는 사용하지 않는다.
영문으로 표기하는 경우 동사(R)를 가장 앞에 두고 첫 글자를 대문자로 표기한다.

3. 본문

• 한 줄 최대 72자
• 최대한 상세하게 작성
• 변경 내용, 이유를 설명

4. 꼬리말

트래커 id를 작성하며, 여러 개의 이슈 번호는 , 로 구분
"유형: #이슈번호" 형식으로 사용한다.

• Fixes : 이슈 수정 중 (아직 해결하지 않음)
• Resolves : 이슈를 해결
• Ref : 참조할 이슈가 있을 때 사용
• Related to : 해당 커밋에 관련한 이슈 번호 (아직 해결하지 않음)

커밋예시

Feat: Add signin, signup

네이버 API를 이용하여 회원가입, 로그인 기능 추가

Resolves: #1