Home

⛳️반드시 지켜야 하는 Git Convention

📍 Issue 컨벤션

template에 맞게 issue를 작성해주세요. 기존에 만들어둔 template을 사용하면 됩니다.😀

📍 Branch 이름 컨벤션

작업 단위마다 이슈를 생성하고, branch 이름에 작업 설명과 이슈 이름을 아래와 같이 남깁니다.

#이슈번호/feature/이슈 제목
#이슈번호/fix/이슈 제목
#이슈번호/test/이슈 제목
#이슈번호/refactor/이슈 제목

📍 Commit message 컨벤션

commit은 유의미한 작업 단위별로 나누어 자주 커밋해주세요🤸🏻‍♂️ 키워드는 대문자로 작성해주세요.

Feat: commit 내용


ex. Feat: 공통 사이드바 컴포넌트 ui 구현

해당 이슈와 관련없는 커밋은 하지 않습니다. 관련없는 커밋이 필요하다면 새로운 이슈를 작성하고 브랜치를 변경해주세요.

📍 Commit Type

저희가 사용할 커밋 타입들입니다. 아래 작성된 내용에 맞는 타입을 선택하여 커밋해주세요.

- Feat : 새로운 기능 추가
- Fix: 버그 수정
- Docs: 문서의 수정
- Style: (코드의 수정 없이) 스타일(style)만 변경
- Refactor: 코드를 리팩토링
- Test: Test 관련한 코드의 추가, 수정 (Storybook 작업 포함)
- Chore: (코드의 수정 없이) 설정을 변경 및 새로운 라이브러리 혹은 패키지 설치
- Modify: 기존 기능의 변경(코드 변경)
- Rename: 디렉토리 구조 변경
- Cleanup: 콘솔 로그 및 주석 삭제, 파일 삭제, 불필요한 함수 삭제, 코드 위치 변경
- Merge: pull 과정 중 현재 commit과 자동병합이 일어날때 필수적으로 적어줘야하는 commit에 적어줌

📍 Pull Request 컨벤션

다음과 같은 형식으로 pr 제목을 작성해주세요. 또, pr 내용은 template에 맞게 작성해주세요. 여기도 commit type의 첫 글자는 대문자입니다. pr 제목에만 이슈번호가 붙으니 이 점 유의해주세요!!

[#이슈번호] CommitType: 구현 내용 간략히

ex) [#11] Feat: 공통 사이드바 컴포넌트 ui 구현