-
Notifications
You must be signed in to change notification settings - Fork 0
commit_convention
hyeyoon Jung edited this page Jul 26, 2021
·
2 revisions
- 구현할 기능에 대한 issue를 생성합니다.
- issue 라벨과 issue 번호를 조합해 브랜치를 생성합니다.
- ex)
feat/#3/login
- ex)
- 다음의 형식으로 작성합니다. 커밋메시지에 본문을 추가하는 건 선택사항이지만 권장합니다.
type : #이슈번호 Subject(제목)
type 종류
- FEAT : 새로운 기능 추가
- FIX : 버그 수정
- DOCS : 문서 수정 (ex, README.md)
- STYLE : 포매팅, 세미콜론 누락 등 수정 (기능상 코드변경 없음)
- PERF : 성능 개선
- REFACTOR : 기존코드 리팩토링 (기능상 변화는 없음)
- TEST : 테스트 코드 작성 (기능상 코드변경 없음)
- CHORE : 빌드 업무 수정, 패키지 매니저 수정 (기능상 코드변경 없음)
- Issue 제목은
[BE],[FE],[COMMON]구분으로 시작합니다.ex) `[BE] skeleton 코드 작성` ex) `[FE] 컴포넌트 무한 새로고침 문제 해결` ex) `[COMMON] wiki에 기획서 업로드` - 적절한 label을 붙여줍니다.
- 본문에는 어떤 작업을 할 것인지와, 공유할 사항을 작성합니다.
- Pull Request 제목은 issue 라벨 + issue 번호로 시작합니다.
- Backend와 Frontend 저장소가 분리되어 있으므로
BE,FEprefix는 생략
ex) FIX: #31 로그인 오류 수정 ex) FEAT: #50 DB에 데이터 추가하는 로직 작성 - Backend와 Frontend 저장소가 분리되어 있으므로
- PR 템플릿에 맞춰 본문을 작성합니다.
- 본문 마지막에
Close #3이렇게 작성해 PR이 merge 될 때 issue가 자동으로 Close 되게 합니다. - 2명 이상의 approve 를 받으면 merge 합니다.
💡 issue와 pr은 Open 되면 자동으로 Project 칸반보드에 생성됩니다 !