협업 전략 - TaeKyeongKim/airbnb GitHub Wiki

작업 순서

  1. 마일스톤 생성 혹은 선택
  2. Github 이슈 생성
  3. 브랜치 생성
  4. Pull Request 추가, Github 이슈 링크

마일스톤

매주 수, 금요일에 upstream 에 PR 을 올리기 위한 마일스톤을 작업하기 전에 생성
깃 이슈 추가 시에 마일스톤을 태그

(프로젝트 기간 동안 프론트엔드, 백엔드 각각 마일스톤을 6개씩 생성)

Github 이슈 규칙

브랜치를 생성하기 전에 먼저 Github 이슈에 작업사항을 올리기

Git Issue Template 

---
name: Feature Request
about: Suggest new Feature Request for this project
title: "[FE | BE] {ISSUE_TITLE}"
labels: ''
assignees: ''
---

## 🤷‍♂️ Description

<!-- 구현하고자 하는 기능에 대해 작성해 주세요. -->



## 📝 Primary Commits

<!-- 세부 구현 사항을 리스트로 작성해주세요. -->

- [X] 세부 구현 사항 1
- [ ] 세부 구현 사항 2
- [ ] 세부 구현 사항 3

## 📷 Screenshots

<!--스크린샷으로 보여줄 수 있는 이미지가 있다면 첨부해주세요!-->



<!--마지막으로 이슈 생성 시 우측의 옵션들을 체크했는지 확인해주세요!-->
Bug Report Template 

---
name: Bug report
about: Create a report to help us improve
title: "[FE | BE] : {BUG_TITLE}"
labels:
assignees: ''
---

## 🔄 How to reproduce bug

<!--어떻게 하면 버그를 다시 만들 수 있는지 과정을 설명해주세요!-->

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

## 🤔 Concerns

<!--고려해야할 점은 무엇이 있는지 작성해주세요!-->



## 📷 Screenshots

<!--스크린샷으로 보여줄 수 있는 이미지가 있다면 첨부해주세요!-->

    
    
<!--마지막으로 이슈 생성 시 우측의 옵션들을 체크했는지 확인해주세요!-->

브랜치 규칙

feature 브랜치 생성 시 {ISSUE_TYPE}-{fe/be/ios}/#{ISSUE_NUMBER}-FEATURE_NAME 와 같이 브랜치를 생성
예시) feature-be/#1-spring_initializr

커밋 규칙

아래 링크의 컨벤션에 따라 커밋 메시지를 작성

http://karma-runner.github.io/5.0/dev/git-commit-msg.html

예시 : feat: [#1] spring initializr 추가

Commit Template 

feat: [#ISSUE_NUMBER] spring initializr 추가

(body 는 작업 내에 세부 구현 사항이 있는 경우에만 작성)
- 세부 구현사항 1
- 세부 구현사항 2
- 세부 구현사항 3
...

(footer 는 작성하지 않음)

** 타입 구분

위 링크의 컨벤션에 따라 작업사항을 아래와 같이 구분

  • feat (new feature for the user, not a new feature for build script)
  • fix (bug fix for the user, not a fix to a build script)
  • docs (changes to the documentation)
  • style (formatting, missing semi colons, etc; no production code change)
  • refactor (refactoring production code, eg. renaming a variable)
  • test (adding missing tests, refactoring tests; no production code change)
  • chore (fix typo; updating grunt tasks etc; no production code change)
  • build (Commits to build-related files)
  • deploy (Commits to deploy-related files)

PR 규칙

image

origin PR

각 feature 브랜치를 frontend, backend 브랜치에 merge 하기 위해 PR 생성

upstream PR

frontend 와 backend 브랜치에 feature 단위가 모이면 upstream 의 team-2 브랜치로 PR 생성

PR Template

origin PR Template

다른 팀원이 보고 이해할 수 있도록 구현 결과를 스크린샷/이미지로 추가

## 🤷‍♂️ Description

<!-- 구현하고자 하는 기능에 대해 작성해 주세요. -->



## 📝 Primary Commits

<!-- 세부 구현 사항을 리스트로 작성해주세요. -->

- [X] 세부 구현 사항 1
- [ ] 세부 구현 사항 2
- [ ] 세부 구현 사항 3

## 📷 Screenshots

<!--스크린샷으로 보여줄 수 있는 이미지가 있다면 첨부해주세요!-->



<!--마지막으로 이슈 생성 시 우측의 옵션들을 체크했는지 확인해주세요!-->

upstream PR Template

리뷰어가 보고 이해할 수 있도록 자세한 설명/질문 및 스크린샷/이미지로 추가

Title: [team-2][MEMBER_NAME] {제목} {Tag}

PR 구현 사항에 대한 요약
⚠️ **GitHub.com Fallback** ⚠️