Skip to content

협업 규칙

doyeon edited this page Jan 30, 2022 · 2 revisions

1. Issue

큰 작업 단위는 팀 노션에서, 세부적인 작업 단위는 Github Issue에서 관리한다.

1.1 Issue Template

이슈는 다음과 같은 지정된 템플릿에 맞게 작성한다.

Issue Template

[사전 작업 내용은 확인 후 삭제할 것]

사전 작업

  • 라벨 추가
  • assign 지정
  • 체크리스트 형태로 작성

구현할 사항

  • ex1
  • ex2

1.2 Issue Label

다음과 같은 종류의 라벨을 사용한다.

라벨명 설명
feature 구현할 기능
refactor 리팩토링
hotfix 버그 수정
layout UI 수정
doc 문서 수정

2. Pull Request

가능한 한 작업단위, 기능단위로 개발한 뒤 Pull Request를 작성한다.

2.1 Issue Template

Pull Request는 다음과 같은 지정된 템플릿에 맞게 작성한다.

Pull Request Template

[사전 작업 내용은 확인 후 삭제할 것]

사전 작업

  • 라벨 추가
  • assign 지정
  • 체크리스트 형태로 작성
  • Issue 연결
  • 브랜치 확인
  • upstream의 최신 내용을 반영했는지 확인
  • 작성하지 않은 부분은 삭제

구현한 사항

  • ex1
  • ex2

구현 결과

  • 이미지, gif, 영상 첨부
설명1 설명2

관련 이슈

  • #issue number, #issue number

2.2 Issue Label

다음과 같은 종류의 라벨을 사용한다.

라벨명 설명
feature 구현할 기능
refactor 리팩토링
hotfix 버그 수정
layout UI 수정
doc 문서 수정

3. 리뷰

  • 본인이 본인의 PR을 Merge 한다.
  • 필요에 따라 상호 리뷰를 요청한다.