이번엔 PR 템플릿을 만들어보도록 하겠습니다
적용 전, 후
시작하기 전에 먼저 PR 템플릿 적용 전 후의 이미지를 보여드리자면 아래와 같습니다.
Pull request를 등록할 때 템플릿이 없다면
위 사진과 같이 아무 내용이 없는 것을 볼 수 있습니다.
템플릿이 있다면
PR을 등록할 때 이렇게 자동으로 글이 작성되어 있습니다.
아래 사진은 위 템플릿을 적용하여 작성한 PR 입니다.
목적
앞서 작성한 내용들을 다 읽어보셨다면 PR은 코드 리뷰에 있어서도 중요하고, 의견을 주고 받을 수 있는 토론의 장으로도 사용되며, 등록한 이슈와 연결하여 어떤 작업에 관한 변경사항인지 파악할 수 있게 된다는 것을 알 수 있습니다.
추가로 PR을 작성할 때 리뷰어가 해당 PR만 보고도 어떤 작업을 진행했는지 한 눈에 파악할 수 있도록 한다면 좀 더 효율적으로 프로젝트가 진행되겠죠?
이때, PR 템플릿을 적용하게되면 미리 작성된 형식 안에 내용만 작성하면 되기 때문에 작성하는 시간을 절약할 수 있고, 팀원 모두가 같은 템플릿을 사용하기 때문에 개개인의 글을 작성하는 스타일과 크게 관계없이 PR의 내용을 쉽게 파악할 수 있게됩니다.
적용하기
그럼 이제 적용하는 방법을 알아보겠습니다.
Github 페이지에서 적용하는 방법을 알아보겠습니다~
1. Add file > Create new file
2. pull_request_template.md 생성하기
이때, 루트 경로에 pull_request_template.md를 생성하거나
docs/pull_request_template.md를 생성하거나
.github/pull_request_template.md를 생성하는 3가지 방법이 있는데
전 마지막 방법을 선택했습니다.
pull_request_template.md는 마크다운 문서이기 때문에 마크다운 문법을 활용하여 템플릿을 작성해주시면 됩니다.
작성이 끝났으면 우측 상단의 Commit changes...를 누릅니다.
3. merge를 진행합니다.
- Commit directly to the main branch를 누르면 main으로 바로 올라갑니다.
두번째 버튼을 클릭시 PR 후 merge 과정을 거칩니다.
편하신 것으로 선택하시면 됩니다.
여기선 두번째를 선택하고 진행하겠습니다.
- create pull request를 누릅니다.
- 여기서 저는 설정해놓은 것이 있어서 빨간색으로 보이지만 어떤 설정을 하지 않으셨다면 초록색으로 보이실 겁니다. Merge pull request를 눌러줍니다.
main에 병합이 되었습니다.
이제부터는 PR을 할 경우 작성해놓은 템플릿이 나오게됩니다.
위 과정은 IDE에서 template 파일을 생성 후 main에 merge를 해도 됩니다.
4. 적용 확인
이후부터 PR을 할 때는 아래와 같이 템플릿이 적용되어있는 것을 확인할 수 있습니다.
