github ISSUE/PR template 등록하기

 

github에서 Issue를 어떤 용도로 사용하는지 몰랐다가 부캠 들으면서 배웠다. 
이슈는 팀 내 todo list처럼 해결해야 할일을 세분화해서 적어놓고, 누군가에게 assign 해서 볼 수 있으며,
관련된 commit 도 연결시킬 수 있어서 엄청 편리한 기능이라는 걸 알았다. 
우리 팀은 서로 하고 있는 걸 어떻게 공유하고, github은 어떻게 잘 사용할 수 있을까? 고민했는데, issue를 잘 활용하면 되는 거였다. 

PR은 pull request의 줄임말로, 새로운 실험이나 기능들을 branch에서 작업하고, main에 merge할 때, 팀원들의 확인을 받을 수 있는 github의 기능이었다. pull request하는 과정에서 코드리뷰도 받을 수 있고, 특정 코드에 댓글을 달아 리뷰할 수도 있었다. 나는 써보지 못했지만, 다른 친구가 PR을 올린 걸 리뷰하고, merge 해봤다. 다른 사람의 코드 보는 건 오래걸렸지만, 내가 몰랐던 기능도 쓰는 걸 보고 배웠다. 대회 끝나기 전에 써보겠다 다짐했는데, mmdetection 살펴보느라 바빠서 못써봐서 너무 아쉽다ㅠㅠ

Issue Template 등록하기

참고https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/manually-creating-a-single-issue-template-for-your-repository

UI에서 등록하는 쉬운 방법

• 해당 repository > settings > General 탭 > Feature의 issue > Set up templates

repository에서 등록하는 방법

Organization에 속해 생성된 repository에 접근할 때는 권한이 없어 위 방법으로 등록할 수가 없었다. 

1. repository 내에 .github 폴더를 생성
2. 해당 폴더 내에 ISSUE_TEMPLATE 이라는 폴더 생성
3. \.github\ISSUE_TEMPLATE 경로에 이슈 템플릿으로 사용할 파일들 markdown 형식으로 저장
   예) feature_request.md, bug_report.md
4. 이슈 생성 시, 템플릿을 선택할 수 있는 창이 뜨고, 템플릿을 사용할 수 있게 된다. 
5. 단일 템플릿만 사용할 경우, ISSUE_TEMPLATE이라는 폴더를 만들지 않고, 그냥 issue_template.md 라는 이름으로 .github내에 파일을 저장해놓아도 된다. 

PR Template 등록하기

1. 위에서 생성한 .github 디렉토리 내에 PULL_REQUEST_TEMPLATE 이라는 디렉토리 생성
2. \.github\PULL_REQUEST_TEMPLATE 경로에 PR 템플릿으로 사용할 파일들 markdown 형식으로 저장
   예) pull_request_template.md
3. pull request를 생성할 경우, 템플릿을 선택할 수 있다.
4. 이슈 템플릿과 마찬가지로 단일템플릿만 사용할 경우, PULL_REQUEST_TEMPLATE 폴더를 만들 필요 없이, pull_request_template.md 라는 이름으로 .github에 저장해놓으면 된다.