Skip to content

협업 전략

dooohun edited this page Nov 5, 2024 · 4 revisions

브랜치 전략

Git-Flow

  • main

    프로덕션에 배포되는 안정된 코드

  • develop

    개발자들이 기능을 병합하는 브랜치

    이곳에서 테스트가 완료되면 main으로 병합

  • feature/{package}/{name}

    각 기능별로 생성된 브랜치

    패키지나 모듈 단위로 구분해 브랜치를 생성

머지 전략

  • PR이 머지된 후 본인이 현재 작업 중인 브랜치를 최신화 한다.
//develop 브랜치 업데이트 시
git checkout develop

// develop branch
git pull

// 작업 브랜치
git merge develop
  • conflict가 나면 스스로 해결하고 필요하다면 이전 PR assignee에게 도움을 요청한다.

ISSUE 템플릿

기능 요청 Issue 템플릿

## 어떤 기능인가요?

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

## 작업 상세 내용
<!--
- [ ] TODO
- [ ] TODO
- [ ] TODO
-->
## 참고 자료

버그 리포트 Issue 템플릿

## 어떤 버그인가요?

<!-- 어떤 버그인지 간결하게 설명해주세요 -->

## 어떤 상황에서 발생한 버그인가요?

<!-- (가능하면) Given-When-Then 형식으로 서술해주세요 -->

## 예상 결과
<!-- 예상했던 정상적인 결과가 어떤 것이었는지 설명해주세요 -->

## 참고 자료

PR 템플릿

PR 제목 - [FE / BE / 공통 - #이슈번호] - 작업내용

예시

  • [FE - #13] - 공통 컴포넌트 작업
  • [BE - #14] - 백엔드 테스트 코드 작업
## #️⃣연관된 이슈

<!-- ex) #이슈번호, #이슈번호 -->

## 📝작업 내용

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

### 스크린샷

## 💬리뷰 요구사항

<!-- 리뷰어가 특별히 봐주었으면 하는 부분이 있다면 작성해주세요 -->

<!-- ex) 메서드 XXX의 이름을 더 잘 짓고 싶은데 혹시 좋은 명칭이 있을까요? -->
## 참고 자료

커밋 컨벤션

  • 커밋 타입(영어): 커밋 내역(한글)
    • feat : 새로운 기능 추가
    • fix : 버그 수정
    • docs : 문서 수정
    • style : 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우
    • refactor : 코드 리펙토링
    • test : 테스트 코드, 리펙토링 테스트 코드 추가
    • chore : 빌드 업무 수정, 패키지 매니저 수정
  • 본문은 선택사항
Clone this wiki locally