Skip to content

Latest commit

 

History

History
76 lines (46 loc) · 6.2 KB

File metadata and controls

76 lines (46 loc) · 6.2 KB

Pull Request (PR) 작성 방법

  • 작업하고자 하는 Repository에 접속해 우측 상단에 있는 Fork 버튼을 클릭한다.
    • 최초 1회만 Fork 작업을 진행하면 되고, 한 번 Fork 작업을 진행한 Repository는 다시 진행할 필요가 없다.

image

  • 다른 것은 건들일 필요 없이 Create Fork 버튼을 클릭한다.

image

  • 버튼을 눌렀다면 자동으로 자신의 Repository에 Fork된 페이지로 이동될 것이다.

image

  • 이제 자신이 수정하고자 하는 파일에 들어가 수정 작업을 진행한다.

image

  • 수정 작업을 마쳤다면 우측 상단에 있는 Commit changes... 버튼을 클릭한다.

image

  • Commit message는 Commit Rule에 따라 작성하고, Extended description은 수정사항에 대해 간략한 설명을 작성한다.
  • 하단에 있는 branch 파트는 'Commit directly to the master branch'에서 'Create a new branch for this commit and start a pull request'로 변경하고, Branch name을 Branch Rule에 맞게 작성해 프로젝트의 분기점을 만들어준다.
    • 이때, 자신이 PR 작업을 진행하면서 분기점을 한 번이라도 만들었다면 (헌재 진행중인 PR에서 위의 작업을 한 번이라도 진행한적이 있다면) 이 옵션을 선택하지 말고 Commit directly to the [branch name] branch 옵션으로 둔다.
    • 이미 Branch를 새로 만들었음에도 수정할 때마다 New Branch를 하게 된다면 불필요한 branch가 생성되며, PR에 자신이 수정한 사항이 전달되지 않는다.

image

  • Propose changes 버튼을 클릭하면 자동으로 Pull Requests 창으로 넘어올텐데, title과 description을 작업 협약에 맞춰서 작성한다.

image

  • 이때, 본문과 댓글에서 Markdown 문법을 통해 글을 작성할 수 있는데, 자세한 작성 방법(문법)은 Markdown Syntax 문서를 참고할 것.

image image

  • Reviewers에 Project Leader를 선택한다.
    • 만약 자신이 직접 설정할 수 없는 상태라면 Reviewers~Labels 까지의 작업은 스킵해도 된다. 대신 PR 문서를 전부 작성했다면 Project Leader에게 연락을 취할 것.

image

  • Assignees에는 자신과 Project Leader를 선택한다.

image

  • Labels에는 이 PR이 해당하는 항목을 선택한다.

image

  • Create Pull Request 버튼을 클릭하면 아래와 같은 페이지가 열릴 것이다.

image

  • 이후 Project Leader가 PR을 확인하고 master branch에 merge했다면 자동으로 PR은 닫힐 것이다.
    • 만약 Project Leader가 특정 부분을 수정해달라고 Change Request를 보냈다면, 다시 자신의 Repository로 돌아가 master branch가 아닌 새로 만든 branch를 선택하고, 수정 요청을 받은 파일로 들어가 작업을 진행하면 된다.
    • 수정을 진행하고 Commit directly to the [branch name] branch 옵션으로 Propose changes 버튼을 클릭하면 수정 사항이 저장될텐데, 이는 자동으로 PR로도 전송되니 Propose changes를 했다면 다시 PR 페이지로 돌아가 수정 사항이 연동됐는지 정도만 확인해준다.

Screenshot_20231115_144721_Samsung Notes

  • Project Leader가 PR에 관해서 완료됐다고 알려주면 자신의 Repository에 가서 작업한 Branch를 제거해준다.
    • branch 버튼을 클릭하고 View all branches를 클릭한다.
    • master (혹은 main) Branch를 제외한 모든 branch를 휴지통 모양의 버튼을 클릭해서 삭제해준다.

Screenshot_20231115_142037_Samsung Internet Screenshot_20231115_142121_Samsung Internet

  • 이후에 다시 수정이나 추가 등 작업을 진행하려면 또 Fork를 할 것이 아니라, 내 계정에 있는 Fork된 Repository에 들어가 Sync fork -> Update branch를 실행해 Repository를 최신화한 뒤 작업을 진행한다.
    • 만약 Up-To-Date와 같은 메세지가 떠있다면 내가 마지막으로 수정한 이후로 Team Project가 수정된 적이 없다는 뜻으로, 이와 같은 메세지를 확인했다면 이 항목은 무시하고 수정 작업부터 다시 시작하면 된다.

image

PR 예시

끝.