Skip to content

Convention

Yonggoo Noh edited this page Mar 22, 2018 · 1 revision

아래의 분류를 기준으로 모든 브랜치/커밋의 켄벤션 구성

  • docs: 문서 작업(ex. readme 작성)
  • feat: 기능 작업(ex. 새 기능 추가)
  • fix: 버그 수정
  • refact: 코드 리팩토링(ex. 네이밍 변경, 설계 개선 등)

Branch convention

[분류]/#[이슈번호]-[내용(camelCase)]

예: feat/#1234-addNewButtons

해당 작업을 위해 생성한 이슈의 번호를 [이슈번호] 란에 넣는다.

Commit convention

[분류](#[관련 이슈번호]): 메시지

예: feat(#1234): create new issue button

브랜치 규칙과 마찬가지로, [관련 이슈번호]는 해당 작업의 이슈 번호로 지정한다. [분류]의 경우는 각 하나하나의 커밋 내용에 맞춘다.

예: feature 작업을 하던 중 코드 리팩토링을 하였다 -> refact

Clone this wiki locally