Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (34 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

43 lines (34 loc) · 1.67 KB

serverDev

커밋 컨벤션

본 프로젝트는 다음과 같은 커밋 컨벤션을 따른다.

제목 형식

커밋 타입: 설명

  • 커밋 타입 : 커밋의 성격을 나타내는 타입. 아래의 목록에서 하나를 선택한다.
  • Feat : 새로운 기능 추가
  • Fix : 버그 수정
  • Docs : 문서 수정 (README etc..)
  • Style : 코드의 의미에 영향을 주지 않는 변경 (포맷팅 등)
  • Refactor : 코드 리팩토링
  • Test : 테스트 코드 추가, 수정
  • Chore : 빌드 업무 수정, 패키지 매니저 설정 등의 변경

본문

  • 변경 사항에 대한 자세한 설명을 작성한다.
  • 본문은 선택사항이다.
  • 제목과 본문 사이에 한 줄을 비운다.

꼬리말

  • 꼬리말은 선택사항이다.
  • 이슈 트래커 ID를 작성한다. 이 때, 유형: #이슈 번호 형식으로 작성한다.
  • 이슈 트래커 ID가 없는 경우, 이 부분은 생략된다.
  • 이슈 유형 : 아래 중 하나를 선택한다.
  • Fixes : 이슈 수정중 (아직 해결되지 않은 경우)
  • Resolves : 이슈를 해결했을 때 사용
  • Ref : 참고할 이슈가 있을 때 사용
  • Related to : 해당 커밋에 관련된 이슈번호 (아직 해결되지 않은 경우)

예시

Feat: "Add login API"        // 타입: 제목

로그인 API 개발               // 본문

Resolves: #123               // 꼬리말     이슈 123을 해결했으며,
Ref: #456                    //           이슈 456 를 참고해야 하고,
Related to: #48, #45         //           현재 커밋에서 아직 이슈 48 과 45 가 해결되지 않았다.