Skip to content

Convention

김종원 Jongwon edited this page Aug 7, 2023 · 2 revisions

Commit Convention

  • 커밋 메시지 첫 줄 컨벤션은 다음과 같다.
    [태그] #{issue number}: 커밋 메시지의 형태이며 :뒤에만 space가 있음에 유의한다.

예시

[FEAT] #1: 작업 내용

Commit Tag

  • 태그는 영어로 쓰되 대문자로 한다.
  • 태그 종류는 다음과 같다.
    • FEAT: 기능 구현
    • FIX: 버그 수정
    • DOCS: 문서 작업
    • REFACTOR: 리팩토링
    • TEST: 테스트 코드
    • CHORE: 빌드 업무 수정, 패키지 매니저 수정
    • ADD: assets, data 파일 추가하는 경우
    • STYLE: 코드 포맷팅, 세미콜론 누락, UI 디자인 변경 → 코드 변경이 없는 경우

브랜치 룰

Branch Type

  • main : 배포 가능한 상태의 브랜치
  • dev : 개발 과정 중 하나의 feature/bug를 완료하고 merge하는 브랜치
  • feat : 하나의 기능을 구현하는 브랜치
  • hotfix : main에서 긴급한 수정사항이 생겼을 때 수정하는 브랜치
  • bugfix : 개발 과정 중 발생한 버그를 수정하는 브랜치

Naming method

  • branch 양식 {옵션}/{브랜치 명} (소문자, kebab-case) ex) feat/option-selection
Clone this wiki locally