Git Convention
커밋 메시지 구조는 크게 3가지로 나뉜다(제목, 본문, 꼬리말)
type: Subject -> 제목
(한칸 띄우기)
body(생략 가능) -> 본문
(한칸 띄우기)
footer(생략 가능) -> 꼬리말
각 커밋 메시지 구조에는 규칙이 존재한다. 아래에서 좋은 커밋 메시지를 만드는 규칙에 대해 언급하겠다.
ex)
Feat: Add signin, signup
회원가입 기능, 로그인 기능 추가(예시를 위해 간단히 작성)
Resolves: #1
Type 설명
Feat: 새로운 기능 추가
Fix: 버그 수정 또는 typo
Refactor: 리팩토링
Design: CSS 등 사용자 UI 디자인 변경
Comment: 필요한 주석 추가 및 변경
Style: 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우
Test: 테스트(테스트 코드 추가, 수정, 삭제, 비즈니스 로직에 변경이 없는 경우)
Chore: 위에 걸리지 않는 기타 변경사항(빌드 스크립트 수정, assets image, 패키지 매니저 등)
Init: 프로젝트 초기 생성
Rename: 파일 혹은 폴더명 수정하거나 옮기는 경우
Remove: 파일을 삭제하는 작업만 수행하는 경우
-
Main Branch
브랜치 이름 : Main 최종 배포가 가능한 상태만을 관리하는 브랜치입니다.
-
Feature Branch
브랜치 이름 : Feature/<기능명> 브랜치 이름 예시 : Feature/login 기능 개발, 오류 수정 등에 사용되는 브랜치입니다.
[유형/#번호] what- ex) Issue #11에 대해서 완료한 경우 :
[Feature/#11] 로그인뷰 api 연결
- 해당 사항에 맞게 이슈 탬플릿을 선택하여 작성한다.
[유형/#번호] what- ex) Issue #11에 대해서 완료한 경우 :
[Feature/#11] 로그인뷰 api 연결