Skip to content

Conventions

ATeals edited this page Nov 14, 2024 · 3 revisions

Convention

1️⃣ Branch Rules

image

  • Main : 개발 브랜치(dev)

  • Release : 배포 브랜치

  • Feature : 기능 브랜치

    • feature-{#이슈번호}-{기능}
  • Feature 브랜치는 개발 명세 기준으로 Main 브랜치에서 분기

  • Feature 브랜치에서 Main 브랜치로 Merge 할 때 Squash Merge

  • Main 브랜치에서 Release 브랜치로 Merge 할 때 Rebase Merge

2️⃣ PR & ISSUE

✏️ Issue Template

feature template

## 어떤 기능인가요?

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

## 작업 상세 내용

- [ ] TODO
- [ ] TODO
- [ ] TODO

## 참고할만한 자료(선택)

bug template

## 어떤 오류인가요?


## 작업 상세 내용

- [ ] TODO
- [ ] TODO
- [ ] TODO

## 참고할만한 자료(선택)

✏️ PR Template

feature-{#이슈번호}-{기능}
## #️⃣연관된 이슈

> ex) #이슈번호, #이슈번호

## 📝작업 내용

> 이번 PR에서 작업한 내용을 간략히 설명해주세요(이미지 첨부 가능)

### 스크린샷 (선택)

## 💬리뷰 요구사항(선택)

> 리뷰어가 특별히 봐주었으면 하는 부분이 있다면 작성해주세요
>
> ex) 메서드 XXX의 이름을 더 잘 짓고 싶은데 혹시 좋은 명칭이 있을까요?

3️⃣ Commit & Review

✏️ Commit

feat : 새로운 기능 추가
fix : 버그 수정
docs : 문서 수정
refactor : 코드 리펙토링
test : 테스트 코드, 리펙토링 테스트 코드 추가
chore : 빌드 업무 수정, 패키지 매니저 수정

✏️ Review

  • 리뷰어는 FE, BE 파트너 1명
  • 코드는 모두가 보기
  • 최대한 빠르게 리뷰하기
  • Pn룰을 통해 효율적으로 리뷰하기
    🚨 당장 바꿔야 함
    💡 웬만하면 반영
    🙋 그냥 사소한 의견
Clone this wiki locally