본론만 보기를 원하시는 분은 2번부터 봐주세요!
1. 사용하게 된 배경
저는 조그만 스타트업을 다니고 있습니다. IT 팀은 더 한 줌이죠. (진행중인 프로젝트가 여러 개인데도 인원이 너무 한 줌이라 그냥 한 팀 취급...)
이런 작은 팀에서는... 'PR은 이런 형식으로 올리자~', 'ISSUE 는 이런 형식으로 올리자~' 라고 구두로 말해봤자 허공에 흩어져버립니다. 파스스..
이번에 IT팀 생성 1년만에 드디어! 프로젝트에 애자일 방식 프로세스 관리 툴인 Jira 를 도입했습니다. (Jira 사용법에 대해서는 추후 포스팅 후 링크하도록 할게요!)
Jira 를 사용하게 되면서, 할 일마다 이슈 번호가 붙기 시작했습니다.
PROJ-1, PROJ-2 이런 식으로요.
- 먼저 프로젝트 github 과 프로젝트 Jira 를 연결하고
- git branch 와 commit 에 해당 이슈 번호를 포함하게 되면 (ex.
feature/PROJ-1-publishing-main-page,git commit -m "PROJ-1 메인 페이지 퍼블리싱 작업")
Jira 에서 인식을 해서 이슈마다 하단에 해당되는 커밋을 링크해줍니다!!! 사진처럼요 ㅎㅎ
이렇게 branch, commit, PR 제목 naming 방식을 정리하고 나니... 마찬가지로 난장판이었던 PR 내용이 생각났습니다.
그런데 마침 이 게시글을 보다 보니 PR 과 Issue 의 템플릿을 정할 수 있는 방법이 있다고 해 바로 적용하기로 했습니다!~
2. 템플릿 파일 생성하기
저는 develop 브랜치에서 작업했습니다.
먼저, 프로젝트 root 으로 이동해 .github 이라는 폴더를 생성합니다.
mkdir .github만드셨다면 해당 폴더로 이동합니다!
이 곳에 템플릿 파일을 만들면 되는데요,
PR 템플릿을 만들 경우
vi PULL_REQUEST_TEMPLATE.mdIssue 템플릿을 만들 경우
vi ISSUE_TEMPLATE.md해당하는 커맨드를 실행해 파일을 만들어주면 됩니다.
.md(markdown) 파일이 생성되면서 켜졌나요?
템플릿 내에서는 마크다운 문법을 사용해야 합니다.
(이모지도 마크다운 문법으로 작성해야 합니다!)
저의 경우 PULL_REQUEST_TEMPLATE.md 를 이렇게 작성했습니다.
## 개요
내용을 적어주세요.
## 작업사항
- 내용을 적어주세요.
## 변경로직
- 내용을 적어주세요.여기까지 완료하셨다면 프로젝트 remote repository 에 올려주시면 됩니다!!!
git add .
git commit -m "Pull Request 템플릿 생성"
git push origin develop3. 템플릿 사용하기
이제 PR 을 생성하기만 하면 템플릿이 자동으로 적용됩니다!!
출처
