GitHub Pull Request 사용법

꾸준하게 20년·2023년 4월 19일
0

Today's task

소스 코드에 대한 리뷰. 피드백은 아주 중요한 과정이다.
github 를 통해 Pull Request 하는 방법을 알아보자.

1.이슈 등록

  • 코드에 대한 버그 수정 요청, 작업 분배 등과 같이 해야 할 일에 대한 내역을 작성하여 팀원들에게 공유 할 수 있다. 이슈 작성시 작업 담당자를 지정 할 수 있고, Label 을 입력하여 카테고리 별로 확인이 가능 하다. 이슈를 등록하고 완료 했을 경우에는 close 를 하면 되는데 이것은 나중에 작업 이력을 확인 할 수 있어 유용하다.
  • @ 를 사용하여 팀원을 지정 할 수 있고, #을 사용하여 관련 된 commit 을 지정 할 수 있어서 좋다.

2. 코드 작성

  • 이슈로 등록 한 작업에 대한 코드를 작성한다.

3. PR 생성 및 요청

  • PR을 생성 할 때는 작성한 코드에 대해 리뷰어가 잘 이해 할 수 있도록 글을 작성해야 한다.
  • 소스 코드를 push 하고 github 레포지토리를 확인해 보면 PR을 생성 할 수 있다.

    PR 요청은 오픈소스에 기여 하고 싶은 경우에는 fork 하여 진행하고, 같은 팀원끼리 코드 리뷰를 목적으로 할 경우에는 신규 브랜치를 만들고 push 하면 된다.

4. PR 요청

  • PR을 요청 할때 리뷰어를 지정 할 수 있고, 코드 리뷰가 끝나고 merge 할 대상 브랜치를 지정 할 수 있다.

5. 리뷰하기

  • 코드에 대한 의견 및 개선점과 같은 부분을 작성한다. 해당 리뷰를 통해 부족한 점을 보완하고 발전 할 수 있는 계기가 된다.

6. 코드 수정

  • 리뷰를 통해 알게 된 부분을 개선하는 과정이다.

7. 최종 merge 하기

  • 개선이 필요한 부분들에 대한 코드 수정이 완료되고 난 다음 최종 소스를 적용한다.
profile
앞으로 1년

0개의 댓글