이걸 하는 이유

점수를 부여하기 위해서는 정리한 내용에 대한 검토가 이루어져야 한다.

진행 상황 공유 - 자신이 한 내용 분류 - 팀원들의 검토 이 과정을 수월하게 하기 위해 Git의 Issue - Branch - Pull Request 를 활용하려 한다.

Pull Request란

<aside> 💡 참고 링크 : first-contributions

</aside>

Git의 오픈소스들은 어떤 방식으로 contribute & 관리되고 있을까? 보통 다음과 같다.

문제 사항 / 개선 사항 / Bug 등에 대하여 Issue를 작성한다. → 해당 repo를 Fork한다. → Fork 후 각 repo branch naming convention에 따라 Branch를 생성한다. → repo commit convention에 따라 Commit하며 필요한 이슈에 대하여 작업한다. → 해당 과정이 끝나면 Pull Request를 발행한다. → PR 승인되면 작업 내용을 Merge한다.

이러한 플로우를 한 프로젝트에서는 다음과 같이 사용할 수 있다.

구현할 기능에 대하여 Issue를 작성한다. → branch naming convention에 따라 Branch를 생성한다. → commit convention에 따라 Commit하며 맡은 기능을 작업한다. → 해당 과정이 끝나면 Pull Request를 발행한다. → 팀원들이 Code Review를 진행하여 최대한 품질이 좋은 코드에 대하여 토의한다. → 특정 수의 팀원들이 Approve를 남기면 Merge가 가능하다. 이 때, Request Changes 상태가 있다면 무조건 수정되어 해당 상태가 없어져야 Merge가 가능하다.

그래서 우리는 PR을 통하여

  1. 같이 완성할 Repo에 대하여 팀원들의 작업 현황을 모두 공유한다.
  2. PR Review 과정 및 전반적인 Github 사용에 익숙해진다.
  3. 팀 내에서 수정할 수 있는 사항이 있다면 최대한 수정하고 정확한 글로 만들어간다.

PR Review Tutorial


💡 우선 PR 리뷰를 진행하면 점수를 받을 수 있으니, 아래의 약속을 먼저 하자. (기본적인 사항)

  1. 내용을 확인하지 않고 Approve만 누르는 행위는 하지 않는다.
  2. 팀원이 작성한 글에 대한 노력을 생각하고 구체적인 칭찬 한 마디 정도는 Comment로 달아준다.
  3. 개선 사항이 있다면 친절히 comment 하되, 해당 조언을 받더라도 작성자는 기분 나빠하지 않는다.