Skip to content

Guide for Maintainers

Joshua Chung edited this page Aug 8, 2018 · 10 revisions

참고: 이 글은 이 프로젝트의 maintainer들을 위한 글입니다. 그리고 가장 말을 듣지 않는 누군가를 위해서 이기도 합니다.

토의 방식

토의는 무조건 Issue를 중심으로 합니다. 또한 Pull Request를 할 사람은 중복 Pull Request를 방지하기 위해 자신을 해당 이슈에 할당하시길 바랍니다. [참고]

Pull Request는 명세서 작성 중의 오류를 거르기 위해서만 사용합니다. 전체적인 틀은 Issue에서 정합니다.

Issue tag

만약 proposals 이슈 중 수락이 되었다면 accepted tag를 달아주시길 바랍니다. 오직 토의를 통해 허락된 이슈만 달아주시길 바랍니다.

Pull Request

Review Pull Request [참고]

  1. Pull Request를 승인하고 싶을 경우 어떤 Pull Request > Files Changed > Review Changes> > Approve 순으로 진행하면 됩니다.

  2. Pull Request의 수정을 요청하고 싶을 경우

    1. 어떤 Pull Request > Files Changed > Review Changed
    2. 특정 파일에 원하는 라인에 커서를 가져다 놓으면 +가 뜸. 선택함
    3. 뜬 창에 코멘트 입력 > Start a review
    4. 원할 때까지 2~3 과정 반복.
    5. Review Changes > Request Changes > Submit Reviews

Merge Pull Request

Merge 조건

최소한 두명 이상의 Maintainer가 Approve 했을 경우에만(Review Pull Request > 1번 참고) Merge할 수 있습니다. 현재는 자기 자신과 다른 한 사람이지만요... 미래가 있잖아요?

Merge 방법

Pull Request를 Merge할 경우에는 간단한 Commit History를 위해 Rebase Pull Request로 Merge해주시길 바랍니다. [참고]

Rebase Pull Request는 fast-foward로 Merge가 됩니다.

하지만 unstable에서 master로 Merge할 경우에는 절대로 Pull Request를 통해서 하지 마시고 local에서 다음과 같은 과정으로 해주시길 바랍니다.

$ git checkout unstable
$ git pull origin unstable
$ git checkout master
$ git merge unstable
$ git push origin master

이 과정은 unstable과 master를 같은 브랜치로 만들기 위한 과정입니다.

주의: 절대로 Pull Request가 conflict하다고 해도 바로 닫지 마세요. 우선은 보낸 사람에게 수정해달라고 요청을 해주시길 바랍니다.

주의: 섣부르게 Pull Request를 Merge하지 마세요. 오류를 방지하기 위해 충분히 검토를 한 후 Merge하시기 바랍니다.

Push

다른 사람들과의 얘기 없이는 절대로 force push하지 마세요. force push는 다른 contributer에게 매우 안 좋은 상황을 만들 수 있습니다. 예로 들면 그 사이에 업데이트 된 다른 contributer의 commit이 없어지거나 force push하기 이전의 branch를 pull한 사람들은 다 conflict가 날 수 있습니다.