Github Pull Request Template 만들기
- 최근 동기와 서비스 하나를 진행해보자 하는 야망을 품고 프론트엔드 개발을 맡아 진행중이다.
- 아직 초보자인데다가 개발 경험이 많이 없어서 경험하지 못한 것들을 많이 해보고 싶어서 프론트 1명, 백엔드 1명이서 개발을 진행함에도 불구하고 내 깃허브로 fork 해와서 풀리퀘스트, 머지를 지속해서 사용해보기로 결정하였다.
- 동기는 따로 해본 경험이 나보다 많기에 나에게 PR 템플릿 하나를 던져주었고, 이런 기능이 있는지 몰랐는데 신기해서 포스트를 작성하게 되었다.
- 필자는 깃크라켄이라는 git GUI를 사용하고 있다.
:: PR Template?
깃허브로 협업을 하다보면 PR과 Merge를 할 일이 생긴다.
지금 초짜인 내가 설명하기엔 어려움이 있다고 판단되어 후에 이해가 되어 글로 표현할 수 있는 정도의 지식이 섭렵되면 포스트를 작성하겠다.
-
PR에 대해 내가 아는 내용을 간단하게 적어보자면
보통 개발자들이 한 명이 아니라 여러 명이서 협업을 진행하게 될 경우
레포지토리 하나를 전부 master(main) 브랜치로 푸쉬를 하게 될 수가 있다. -
더 간단히 말하자면 회사에서 신입이 코드를 그냥 master(main) 브랜치로 Push를 진행해버릴 수가 있다는 점이다.
-
PR(Pull Request)는 본인이 본인의 깃에 레포지토리를 fork 해가서 나만의 공간에서 작업을 진행한다음 내가 작성한 코드들을 실체 레포지토리에 적용을 하기 위해 요청을 보내는 것을 뜻한다.
-
이렇게 요청을 보내면 내 요청사항과 코드를 보고 사람들이 리뷰를 달아주면서 피드백을 진행할 수도 있고 최종 관리자에게서 승인이 떨어지면 Merge를 통해서 내가 작성한 코드가 실체 레포지토리에 적용이 되는 것이다.
### PR Type
<!— Please check the one that applies to this PR using "x". —>
- [ ] 버그수정(Bugfix)
- [ ] 기능개발(Feature)
- [ ] 코드 스타일 변경(Code style update) (formatting, local variables)
- [ ] 리팩토링 (no functional changes, no api changes)
- [ ] 빌드 관련 변경
- [ ] 문서 내용 변경
- [ ] Other… Please describe:
### 요약(Summary)
### 상세 내용(Describe your changes)
### Issue Number or Link이것이 내가 동기에게 받은 Template이다.
:: 사용하는 방법
이것도 정확하지 않을 수 있는데 현재 나는 이렇게 진행하고 있음을 전한다.
- 실체 레포지토리, 작업 레포지토리에 .github라는 폴더를 생성한다.
- pull_request_template.md 이라는 마크다운 확장자 파일을 생성하고 저 안의 내용을 넣어 저장한다.
- PR을 진행할 때 PR template을 활용할 수 있다.
위에서 말했듯이 나는 github를 시작하자마자 바로 GUI 툴을 사용해버린 사람이다.
동기는 터미널로 진행하고 있는데 나는 깃 크라켄을 사용하고 있기 때문에 크라켄으로 간단히 사진 예시를 들고 종료하겠다.
다음과 같이 템플릿에서 양식을 선택할 수 있다.
선택을 하면 자동으로 Description에 템플릿의 내용이 생긴다.
이를 이용하여 PR을 날릴 때 내가 한 작업 내용을 가독성 좋게 컨벤션에 따라 작성하고 협업을 진행할 수 있다.
