컨벤션
feature branch
- 어떤 이름도 가능하다. 단,
master,develop,release-...,hotfix-...같은 이름은 사용할 수 없다. -
feature/기능요약형식을 추천한다. ex)feature-login -
feature/{issue-number}/{feature-name}이슈추적을 사용한다면 이와 같은 형식을 따른다.
-
제목과 본문을 빈 행으로 구분한다
-
제목을 50글자 내로 제한
-
제목 끝에 마침표 넣지 않기
-
제목은 명령문으로 사용하며 과거형을 사용하지 않는다
-
본문의 각 행은 72글자 내로 제한
-
어떻게 보다는 무엇과 왜를 설명한다
헤더는 필수이며, 범위(scope), 본문(body), 바닥글(footer)은 선택사항입니다.
<type>(<scope>): <subject> -- 헤더
<BLANK LINE>
<body> -- 본문
<BLANK LINE>
<footer> -- 바닥글
**<type>**은 해당 커밋의 성격을 나타내며 아래 중 하나여야 합니다
| init | 프로젝트 처음 추가하는 경우의 커밋 |
|---|---|
| feat | 새로운 기능에 대한 커밋 |
| fix | 버그 수정에 대한 커밋 |
| build | 빌드 관련 파일 수정에 대한 커밋 |
| chore | 그 외 자잘한 수정에 대한 커밋 |
| ci | CI관련 설정 수정에 대한 커밋 |
| docs | 문서 수정에 대한 커밋 |
| style | 코드 스타일 혹은 포맷 등에 관한 커밋 |
| refactor | 코드 리팩토링에 대한 커밋 |
| test | 테스트 코드 수정에 대한 커밋 |
| remove | 코드(파일) 의 삭제가 있을 때 |
**<body>**는 본문으로 헤더로 표현할 수 없는 상세한 내용을 적습니다.
헤더로 표현이 가능하다면 생략 가능합니다.
**<footer>**는 바닥글로 어떤 이슈에서 왔는지 같은 참조 정보들을 추가하는 용도로 사용합니다예를 들어 특정 이슈를 참조하려면 close #1233 과 같이 추가하면 됩니다.close는 이슈를 참조하면서 main브랜치로 푸시될 때 이슈를 닫게 됩니다.
-
제목과 본문을 빈 행으로 구분한다
-
제목을 50글자 내로 제한
-
제목 끝에 마침표 넣지 않기
-
제목은 명령문으로 사용하며 과거형을 사용하지 않는다
-
본문의 각 행은 72글자 내로 제한
-
어떻게 보다는 무엇과 왜를 설명한다
헤더는 필수이며, 범위(scope), 본문(body), 바닥글(footer)은 선택사항입니다.
<type>(<scope>): <subject> -- 헤더
<BLANK LINE>
<body> -- 본문
<BLANK LINE>
<footer> -- 바닥글****은 해당 커밋의 성격을 나타내며 아래 중 하나여야 합니다
| init | 프로젝트 처음 추가하는 경우의 커밋 |
|---|---|
| feat | 새로운 기능에 대한 커밋 |
| fix | 버그 수정에 대한 커밋 |
| build | 빌드 관련 파일 수정에 대한 커밋 |
| chore | 그 외 자잘한 수정에 대한 커밋 |
| ci | CI관련 설정 수정에 대한 커밋 |
| docs | 문서 수정에 대한 커밋 |
| style | 코드 스타일 혹은 포맷 등에 관한 커밋 |
| refactor | 코드 리팩토링에 대한 커밋 |
| test | 테스트 코드 수정에 대한 커밋 |
| remove | 코드(파일) 의 삭제가 있을 때 |
헤더로 표현이 가능하다면 생략 가능합니다.
는 바닥글로 어떤 이슈에서 왔는지 같은 참조 정보들을 추가하는 용도로 사용합니다.예를 들어 특정 이슈를 참조하려면 close #1233 과 같이 추가하면 됩니다.
close는 이슈를 참조하면서 main브랜치로 푸시될 때 이슈를 닫게 됩니다.