Skip to content

git convention

Minsu edited this page Dec 30, 2021 · 1 revision
  • Base Structure

#{issue_number} [TYPE] : subject

body(optional)

footer(optional)

  • Issue Number

이슈 단위 커밋으로 기능 개발을 관리합니다

GitHub에서 이슈를 트래킹을 할 수 있게 Issue Number를 커밋 메시지에 넣어줍니다

  • TYPE

FEAT: 새로운 기능 개발

FIX: 버그 수정

DOCS: 문서 수정/추가

STYLE: 스타일(xml file) 코드 변경

REFACTOR: 리팩토링

TEST: 테스트 코드 추가/테스트 리팩토링(Room, Retrofit 동작 확인을 위한)

CHORE: Gradle이나 설정 세팅할 때

  • Subject(영어)

Subject는 50글자를 넘어가면 안된다

어떤 변경점이 있는지 설명한다

시작을 add,modify,remove 등

  • Body

부연 설명이나 커밋의 이유를 설명할 때만 사용

Not How, Explain What and Why

  • Footer

Issue Tracker IDs를 적을 때 사용

Clone this wiki locally