[GIT] Bitbucket - PR(Pull Request) Template 만들기

Gitlab, Github의 경우 gitlab/github 디렉토리에 md파일을 생성해서

MR template 혹은 PR(Pull Request) Template을 만들수 있게 제공하고 있습니다.

 

Bitbucket의 경우 PR Template에 대한 자료를 찾기가 굉장히 어려운데 생각보다 단순했다.

 

먼저 PR은 뭐고 Template은 왜 생성하는가?

---

PR(Pull Request)

Pull Request는 저장소의 내용을 Fork(복제)해서 요청하고자 하는 곳에 업데이트를 한 후에 내가 작업한 내용도 적용해달라는 뜻이다.

 

개발자들이 개발용 브랜치(develop) 혹은 각기 다른 브랜치에서 별도의 검토와 절차 없이 Main Branch(master)에 push를 하게되면 어떻게 될까?  동료들의 검토없이 Main branch에 push하여 실제 운영되고 있는 시스템에 배포가 된다면 사고가 생길수도 있다.

PR을 요청하고 나서 PR을 핸들링하는 관리자가 변경된 커밋내용을 검토하고 소스 수정이 필요한 부분은 코멘트를 달거나 이상이 없다면 Approve / Merge를 하게 된다.

 

그렇다면 PR Template은 왜 만들까?

---

PR(Pull Request) Template

PR을 요청하고 나서, Description에 어떠한 내용을 수정해서 1~2줄정도 요약본으로 작성하는 경우가 빈번한데

관리자/검토자 입장으로 생각하게되면 사실 1~2줄의 요약본으로는 정확히 무슨내용을 왜 수정했는지 잘 모를수도 있다.

 

그래서 PR용 Description Template을 별도로 만들어 놓으면

PR을 요청하는 개발자와는 Description을 작성하는데 더 편리해질것이고

Approve를 하는 관리자는 이러이러한 내용으로 요청했구나 라고 검토하는데 편해진다.

 

---

Bitbucket PR Template 적용 방법

 

1. Repositories → Pull Requests → Defualt description

 

default description에 Template 양식을 작성 후 Save 버튼을 누르게 되면

 

 

2. Pull Request시 아래와 같이 조금전 Template을 작성한대로 Description에 자동 기입되어져있다.

PR 요청자는 주석처리된 공간에 상황에 맞게 작성하면 된다.

 

 

 

3. 예시 이지만 아래와 같이 PR Template이 있다면 Description을 작성하는데 간편해진다.

 

 

 

몰론, 너무 긴 Template은.. 소요시간이 더 걸릴수도 있겠지만, 팀의 업무 특성에 맞게 Template을 작성한다면

PR 요청에 대한 문구 작성에 크게 할애하지 않아도 되서 개인적으로는 활용하는 것을 추천한다.

 

 

 

 

---

아래의 내용을 참고했습니다

https://velog.io/@ss-won/Git-GitLab-Issue-MR-Template-%EB%A7%8C%EB%93%A4%EA%B8%B0

https://velog.io/@ldhbenecia/Git-Github-Pull-Request-Template

https://green-bin.tistory.com/16

https://holika.tistory.com/entry/Git-%EC%82%BD%EC%A7%88%EA%B8%B0%EB%A1%9D-PR%EC%9D%84-%EC%98%AC%EB%A6%AC%EB%8B%A4-Pull-Request%EC%97%90-%EB%8C%80%ED%95%B4%EC%84%9C