Participation Guide

프로젝트 참여 가이드

저희 프로젝트는 git-flow와 github-pull-request를 사용하여 누구에게나 프로젝트 참여의 가능성을 열어두고 있습니다

프로젝트를 fork 합니다. (incheonjs/react-idevs-materialui-admin-one 저장소)

fork된 내 Github 저장소에서 프로젝트를 로컬에 clone 받거나 download 합니다.

$ git clone https://github.com/[내 깃헙 아이디]/react-idevs-materialui-admin-one.git
$ cd react-idevs-materialui-admin-one

다른 작업보다 먼저 원래 저장소인 저희 주소를 새로운 remote 저장소로 등록해 주세요. (일반적으로 upstream을 많이 사용합니다)

$ git remote add upstream https://github.com/incheonjs/react-idevs-materialui-admin-one.git

다운로드 받은 프로젝트 디렉토리로 이동합니다. git-flow를 따르기 때문에 master에서는 작업하지 않습니다. develop 브랜치로 전환합니다.

$ git checkout develop
$ git pull origin develop

개발을 진행할 feature 브랜치를 생성합니다. (이름은 가급적 중복이되지 않도록 기능 마지막에 github id를 붙여주세요)

$ git branch feature/new-component-myid
$ git checkout feature/new-component-myid
[또는]
$ git checkout -b feature/new-component-myid

개발을 진행하고 완료되면 커밋 후 브랜치를 일단 내 저장소에 먼저 업로드 합니다.

$ git add .
$ git commit -m "[커밋 메세지]"
$ git push origin feature/new-component-myid

내 깃허브 저장소로 들어와서 업로드 된것을 확인하면 upstream 저장소(incheonjs/react-idevs-materialui-admin-one)의 develop 저장소에 반영될 수 잇도록 pull request 날립니다.

코드리뷰를 진행하고 수정 및 반영되면 내 저장소의 develop에도 동기화 합니다.

$ git pull upstream develop
$ git push --all origin