Skip to content

Conventions

eggnee edited this page Dec 2, 2024 · 3 revisions

Code Convention

GitHub - google/styleguide: Style guides for Google-originated open-source projects


Git Branch Strategy

  • GitLab Flow
Branch Description
main 배포용 브랜치
dev 개발 머지용 브랜치
feat 기능 개발용 브랜치
hotfix 버그 처리 브랜치
  • 신규 기능 개발 브랜치 생성 시 반드시 dev에서 진행
  • dev에 머지 후 feat 브랜치 제거
  • 브랜치 명명 규칙: feat/이슈번호-브랜치이름 (예: feat/2-coupon-create)

Commit Convention

Tag Name Description
feat 새로운 기능을 추가
refactor 코드 리팩토링 (성능의 변화는 없음)
enhance 성능 개선
fix 버그 수정
style 코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우
comment 필요한 주석 추가 및 변경
docs 문서 수정
test 테스트 코드, 리펙토링 테스트 코드 추가, 실제 코드 변경 없음
chore 빌드 업무 수정, 패키지 매니저 수정, 패키지 관리자 구성 등 업데이트
rename 파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
delete 파일을 삭제하는 작업만 수행한 경우

예시

feat(#22): 로그인 API 구현
- 로그인 기능 추가
- API 엔드포인트 설계

PR Template

🎯 What is this PR

  • 코드 변경 사유 및 목적 설명 (개요)

📄 Changes Made

  • 구현 내용 설명

🙋🏻‍ Review Point

  • 리뷰어가 확인해야 할 사항 코멘트

✅ Test

  • 완료한 테스트 항목

스크린 샷 첨부

🔗 Reference

Issue #{이슈번호}


Issue Template

어떤 기능인가요?

추가하려는 기능에 대해 간결하게 설명해주세요

작업 상세 내용

  • TODO
  • TODO
  • TODO

Clone this wiki locally