[COMMON] Git,Issue,PR,Branch 컨벤션

Git 컨벤션

merge시,squash and merge방식을 사용하기 때문에 세부 커밋 별로 기능을 명세할 필요는 없다고 판단했다.

Github의 Issue 기능 적극 활용하기!

커밋 컨벤션

• feat: 새로운 기능 추가 및 기능 업데이트 커밋
• refactor: 리팩터링 커밋
• fix: 버그 수정 커밋
• design: CSS 스타일링 커밋
• style: 코드 포맷팅 등 스타일 변경 커밋
• docs: 문서 커밋
• chore: 오타 수정 등 기타 커밋
• test: 테스트 관련 커밋
• build: 배포 커밋
• ci: CI 설정 파일 및 스크립트 변경, GitHub Actions 설정 추가

PR 컨벤션

• PR과 Issue는 일대일 관계
• PR 제목 템플릿 : [BE/FE/Release/Common] (기능 등)

PR 메시지 템플릿

• 이슈 번호 (Resolves #{issue number})
• 어떤 기능을 구현했나요 ?
• 어떻게 해결했나요 ?
• 어떤 부분에 집중해서 리뷰해야 할까요?
• 참고 자료 (optional)

Issue 컨벤션

Issue 제목 템플릿

[BE/FE/Release/Common] ~~한다.

Issue 메시지 템플릿

• 🔍 설명
• ✅ 할 일
• ⏰ 예상 시간
• 🐴 할 말

Git Flow

• main: 운영 배포 브랜치
• develop: 개발 브랜치
• feature: 상세 기능 단위 브랜치
• hotfix: 배포 이후 긴급, 치명적 버그 발생 시 해결 브랜치

해결 이후 main, develop에 모두 merge 필요

브랜치명 컨벤션

• 파트별로 나누어진 issue인 경우: [be/fe]/[feature/fix/refactor 등]/[{이슈 번호}-{이슈 설명}
• 공통 issue인 경우: ex) docs: {이슈 설명}
• checkout locally