본문 바로가기
카테고리 없음

[GitHub] PR 템플릿, 이슈 템플릿 등록하기 (Pull Request Template, Issue Template)

by 월급쟁이 자유인 2019. 5. 21.
반응형

GitHub을 이용해서 소스 코드를 관리할 때 PR(Pull Request)라는 과정을 거치게 된다. PR 등록을 하면 소스코드를 관리하는 개발자나 다른 팀원이 PR에 대한 코드 리뷰를 진행하게 된다.

PR을 등록할 때 소스코드 이외에 어떤 작업이었고 어떤 내용을 고쳤는지 설명도 같이 써주면 좋다. 단순히 커밋 로그와 소스코드만으로는 작업에 대한 완벽한 이해가 어렵기 때문이다.

팀으로 작업을 하는 경우 PR에 대한 보다 자세한 내용을 적어두면 좋은데 이 때 '템플릿' 기능을 사용하면 좋다. PR 템플릿을 등록해 놓으면 PR 등록을 할 때, '이런이런 내용을 등록해주세요'라고 미리 등록된 템플릿이 PR 요청 본문에 먼저 등록이 되고, PR 요청자는 그 본문을 수정하면 된다.

PR 템플릿 등록하기

$ mkdir .github

1. 깃허브 리파지토리(repository)의 root 디렉토리에 '.github'라는 디렉토리를 만든다.

 

PR 템플릿 파일 생성

2. .github 디렉토리 밑에 'PULL_REQUEST_TEMPLATE.md'라는 파일을 만든다. 여기서는 편하게 깃허브 웹 페이지에서 만들었다.

 

3. 이 파일에 템플릿으로 사용할 문자열을 등록해준다. 

 

PR 템플릿 적용 모습

이후 PR 등록을 하면 웹 페이지의 텍스트 영역에 등록해놓은 템플릿 문자열이 기본적으로 등록된다. 주의해야 할 점은 '.github/PULL_REQUEST_TEMPLATE.md' 파일은 기본(base) 리파지토리에 있어야 한다는 점이다.

 

이슈(ISSUE) 템플릿 등록

깃허브의 또 다른 템플릿 사용처로 '이슈 템플릿'이 있다. 소스코드와 관련된 작업이나 버그가 있을 때 관련 내용에 작업을 요청하거나 수정을 진행하기 위해서 이슈를 오픈하게 된다. 이 때, 이슈와 관련된 설명을 남겨야 하는데 여기에도 템플릿이 사용될 수 있다.

 

깃허브에서는 이슈(Issue)를 위한 템플릿 등록을 지원하고 있다. 리파지토리의 [Settings] 탭으로 들어간다.

 

깃허브 이슈 템플릿 추가 버튼

Settings 탭의 'Features' 항목을 보면, 'Issues' 라는 부분이 있고 'Set up templates 라는 버튼이 있다. 이 버튼을 누르면 이슈 템플릿을 등록할 수 있는 화면이 나온다.

깃허브 이슈 템플릿 추가 화면

최초에는 등록된 이슈 템플릿이 없어서 이런 화면이 나온다. 'Add template: select'를 클릭하면

깃허브 이슈 템플릿 추가 버튼

추가할 이슈 템플릿의 타입이 나온다. 버그 리포트를 위한 템플릿과 기능 추가 요쳥을 위한 템플릿 그리고 그 밖에 사용자들이 쓸 수 있는 템플릿이 있다.

추가된 깃허브 이슈 템플릿들

위와 같이 하나씩 추가해나가면 된다. 'Preview and edit' 버튼을 눌러서 추가한 템플릿을 수정할 수 있다.

깃허브 이슈 템플릿 내용 수정

적당하게 템플릿 컨텐츠와 이름, 설명을 추가해준다.

깃허브 이슈 템플릿 수정사항 커밋

템플릿 수정이 끝나면 우측 상단에 있는 'Propose changes' 버튼을 눌러서 변경 사항을 반영해준다.

 

이슈 탭에서 새로운 이슈를 등록하기 위해 [Issue] -> [New Issue]를 선택하면

 

깃허브 이슈 등록 페이지 화면

어떤 타입의 템플릿을 사용할 지 선택할 수 있는 메뉴가 나온다. 버그 리포트를 위해서 이슈 등록을 하려고 했으면, Bug report 항목의 'Get started' 를 눌러서 이슈 생성을 진행한다.

깃허브 이슈 템플릿 적용된 모습

그러면 새로 이슈를 등록하는 화면이 나오고 텍스트 영역에 템플릿으로 등록해 놓은 내용들이 출력된다.

 

PR 템플릿과 이슈 템플릿 기능을 이용해서 좀 더 명확한 커뮤니케이션을 진행 할 수 있다.

반응형

태그

, ,

댓글0