깃허브 컨벤션

브랜치 전략

gitflow 전략을 따른다.

- master : 제품으로 출시될 수 있는 브랜치
- develop : 다음 출시 버전을 개발하는 브랜치
- feature : 기능을 개발하는 브랜치

브렌치 명 컨벤션

main
dev
feature-[be/fe]-[#이슈번호]

gitGraph
    commit
    branch dev
    checkout dev
    branch "feature-be-#1"
    commit
    commit
    checkout dev
    merge "feature-be-#1"
    branch "feature-fe-#2"
    commit
    commit
    checkout dev
    merge "feature-fe-#2"
    checkout main
    merge dev

Loading

Commit 컨벤션

기본 형식

<type>[optional scope]: <description>
[optional body]
[optional footer]

요소 설명

1. type: 커밋의 종류를 나타내며, 일반적으로 다음과 같은 타입 사용
   • feat: 새로운 기능 추가
   • fix: 버그 수정
   • docs: 문서 수정
   • style: 코드 포맷팅, 세미콜론 누락 등 (로직 변화 없음)
   • refactor: 코드 리팩토링 (기능 변화 없음)
   • test: 테스트 추가 또는 수정
   • chore: 빌드 프로세스 또는 보조 도구 변경
2. optional scope: 변경 사항의 범위를 나타냄. (ex. 특정 모듈이나 컴포넌트를 지칭)
3. description: 변경 내용을 간결하게 설명. 명령형으로 작성
4. optional body: 변경 사항에 대한 자세한 설명을 추가. 복잡한 변경 사항이나 이유 등을 설명
5. optional footer: 이곳에는 관련된 이슈 번호나 브레이킹 체인지에 대한 정보를 추가

PR 형식

이슈 단위로 PR 작성 (작업시간 최대 6시간)

• 제목 (필수): 변경/추가 사항의 요약
  • [이슈번호] 제목
• 설명 (필수): 변경/추가 내역 및 설명, 주요 변경 사항, 관련된 Issue 번호
• 스크린샷 또는 데모 (선택 사항)

이슈 / PR 단위

이슈 단위로 PR 작성

• PR이 100줄 넘지 않게
• 이슈 단위는 작업시간 기준 6시간

태그 종류

• FE
• BE
• INFRA
• PLAN
• BUG
• TEST
• REFACTOR
• DESIGN

코드 리뷰

• 팀원전 2명 이상이 승인 또는 리뷰해야 머지가 가능함
  • 기본 : 승인
  • 필요시 : 리뷰 진행
• 승인 / 리뷰 제한시간 24시간
  • 하루에 한번은 꼭 확인해보기

마지막 수정일자 : 2024/11/09