Commit Convention

Commit Template

• 아래 커스텀 템플릿 양식에 맞춰 커밋해주세요.

# <타입>: <제목>

# 제목은 50글자를 넘기지 않으며, 문장의 끝에 마침표를 넣지 않는다.
# 커밋 제목에는 과거시제를 사용하지 않는다.
# 예시 - feat: 로그인 기능 추가


# 본문은 위에 작성
# 본문은 선택사항. 제목 외에 전달하고 싶은 추가 정보가 있을 때 활용한다. 단, 최대 72글자를 넘지 않을 것.
# ------------------
#     제목과 본문을 한 줄 띄워 분리하기
#     본문은 "어떻게" 보다 "무엇을", "왜"를 설명한다.
#     본문에 여러줄의 메시지를 작성할 땐 "-"로 구분
# ------------------

# 꼬릿말은 아래에 작성: ex) #이슈 번호
# 이슈 번호는 github의 issue 번호를 사용합니다.

# --- COMMIT END ---
# <타입>
#   feat    : 새로운 기능 추가
#   fix     : 버그 수정
#   refactor: 코드 리팩토링
#   style   : 스타일 (세미콜론 누락이나 코드 포맷팅 등 코드 변경이 없는 경우)
#   docs    : 문서 추가, 수정, 삭제
#   test    : 테스트 (테스트 코드 추가, 수정, 삭제)
#   chore   : 기타 변경사항 (빌드 스크립트 수정, 패키지 매니저 수정 등)
# ------------------

Git-Flow

Gitflow Workflow 모델에서 relase, hotfix제외하고 사용

• master : 가장 최근의 실행가능한 상태
• develop : 실행가능한 상태를 만든다
• feature : 신규 기능을 위한 브랜치

현재 develop 브랜치가 default로 되어있습니다. 작업 순서는 아래를 참고해주세요.

1. git checkout -b [브랜치명] develop 명령어를 쳐서, develop에서 feature 브랜치를 만든다. 
2. feature 브랜치로 넘어가서 작업한다. 
3. feature 브랜치에서 commit한다. 
4. git push -u origin [브랜치명]으로 feature 브랜치를 리모트 저장소로 push
5. github 레포에서 [브랜치명]으로 들어온 후, feature -> develop으로 pull request를 보낸다.
6. develop에서 merge 한다. 1부터 다시 반복.
7. (개발 완료시) develop -> master로 Pull request 보낸다.
8. (개발 완료시) master에서 merge 한다. 

issue & commit

issue와 commit을 연결해서 작업 틀을 잡습니다. 작업 순서는 아래와 같습니다.

1. 새로 작업하기 전 issue에 해야할 일을 적는다. 
2. 발급받은 issue Number를 확인한다.
3. feature branch 만들때 해당 issue number를 활용한다. 
4. 한 issue가 완성되면, commit할 때 **close #issue-number** 을 추가로 적어 issue를 close한다.