Skip to content

[FE] Git 컨벤션 & 리뷰 규칙

김준서 Junseo Kim edited this page Jan 11, 2025 · 6 revisions

브랜치 전략

  • 기능 별로 "feature/#이슈번호" 브랜치를 따서 개발합니다.
  • 개발 중인 코드는 dev 브랜치에서 관리합니다. 기능 개발이 완료되면 feature 브랜치를 dev 브랜치에 병합합니다.
  • 배포 버전은 main 브랜치에서 관리합니다. 배포 시점에 dev 브랜치를 main 브랜치에 병합합니다.

release

develop/fe

develop/be

feature, refactor (issue에 따라)

  • 커밋 메시지 규칙
    • (이모지 타입 이모지) (커밋 타입): 커밋 설명
      • ✨ feat : 새로운 기능 추가에 관한 커밋
      • 🐛 fix : 버그 수정에 관한 커밋
      • 📝 docs : 문서 작성에 관한 커밋
      • ♻️ refactor : 리팩토링 작업에 관한 커밋
      • 🚚 chore : 기타 자잘한 코드 수정에 관한 커밋
    • stage 후, pnpm commit 명령어를 이용하면 위 구조에 맞도록 쉽게 커밋할 수 있습니다.

FE PR 컨벤션

제목

[feature]: ~ 기능 추가

조건

  • PR은 반드시 작게!
  • 모든 커밋을 다 설명하진 말자
  • 리뷰가 필요한 핵심 기능만 설명
  • 설명 - 커밋번호
    • 코드 넣지말고 커밋 번호만 추가

리뷰

  • 참고하거나 GPT를 사용한 코드라면 반드시 명시하기
  • 24시간 안에 리뷰
  • 혼자가 아닌 함께 하는 일이기에 우리 모두는 코드 리뷰에 책임감을 갖습니다.
  • 인프라 작업이나 릴리즈 PR은 리뷰를 생략할 수 있습니다.
  • 리뷰하기에 양이 많다면, 오프라인 리뷰를 요청하시길 바랍니다.
  • 특별히 신경을 써야 할 리뷰 포인트는 코멘트를 남겨주시면 좋습니다.