[웹 서비스 시작부터 끝까지] #2 GitHub (1) 협업을 위한 설정

Jaeyoo (유재형)·2022년 3월 17일
0
post-thumbnail

1. Git Organization


팀원과 프로젝트를 시작하기로해서 공동 소유의 Repository가 필요하다.
같이 협업을 위한 방법은 두가지가있다.

  1. Invite Collaborator
  2. Organizations

두가지 방법은 차이가 있다.
첫번째 invite Collaborator는 내 저장소에 팀원을 Contributor로 진행하는 방식이고
두번째 Organizations는 공동 소유의 Repository를 만들어 진행하는 방식이다.

우리는 공동으로 프로젝트를 개발하는것이기 때문에 Organizations로 진행했다.
그림과 같이 new organization 하면 간단하게 생성된다.

2. Branch 보호 정책 적용


우리는 이제 기능별로 branch를 나눠서 개발하기로했다. 하지만 실수로 master branch에서 작업을 하고 push를 하는 실수를 할수도 있기때문에 Branch Protection Rules를 만들기로했다.

Branch Protection Rules
: 분기 보호 규칙을 정의하여 강제 푸시를 사용하지 않도록 설정하고, 분기가 삭제되지 않도록 방지하며, 필요에 따라 병합하기 전에 상태 확인을 요구합니다

아래와 같이 추가하면된다.

나는 master 브랜치 보호 정책을 생성했다.

위와 같이 보호정책을 생성하면 아래 3가지를 보호해준다.

  • Merge 하기전에 Pull Request를 꼭 해야한다.
  • 승인이 꼭 필요하다.
    (승인개수 정할수있다. 난 2명이서 프로젝트 하기때문에 승인개수 1)
  • admin도 위 정책을 포함한다.

3. Issue 탬플릿 추가


이번 프로젝트에서는 문서화를 중요하게 생각하기때문에 항상 오류나 프로젝트의 변경사항 혹은 궁금한게 있다면 항상 Issue를 통해서 등록하기로했다. 그렇게한 이유는 우리가 프로젝트를 하면서 어디서 부딪쳤고 어떻게 해결했는지를 기록에 남기고 싶어서 GitHub의 Issue를 잘 활용하기로 했다.

그리고 Issue의 작성방식을 통일화 시켜주었는데 Issue Template을 추가하면된다.
Settings -> General -> Features 에서 Set up templates를 하면된다.

위 같이 설정하면 앞으로 issue 제기할때 아래와 같이 templates를 사용할수있다.

profile
기록과 반복

0개의 댓글