[Github] Pull request template 만들기

본격적으로 바리바리 팀 개발이 시작되었다!

 

파트너와 협업 규칙에 대해서 얘기를 하면서, 빠른 작업 속도를 위해 PR 템플릿을 만들어 사용해보기로 하였다. 

 

1. Pull Request Template이란?

 

깃허브를 통해 개발 프로젝트에 참여를 해보았다면, 커밋한 내역들에 대해 풀 리퀘스트를 날렸던 경험이 있을 것이다. 이때, 풀 리퀘스트를 날리게 된다면 다른 팀원들이 나의 코드를 리뷰할 수 있고, 그 과정에서 보완할 부분이나 코드의 변경 사항에 대해 모두가 알아둘 수 있다.

 

Pull Request 템플릿을 설정해둔다면 풀 리퀘스트를 날릴 때 자동으로 템플릿을 불러와 PR을 날릴 수 있다.  따라서 풀리퀘 형식을 통일하므로서 작업 사항에 관한 이해를 돕고 개발을 빠르게 진행할 수 있다. 

 

2. Pull Request Template 속에 들어가면 좋은 내용들

• 작업 내용
• 코드 변경 사항 및 변경 이유
• 발견된 버그나 이슈
• 리뷰어가 집중해주면 좋을 부분
• 작업 내용 스크린샷
• 참고한 레퍼런스 
• 테스트 계획 및 완료 사항

라인에서 사용하는 PR 템플릿 예시

 

 

3. PR Template 만드는 방법

 

📌나는 Visual Studio Code에서 마크 다운 문서를 작성하고 푸시하는 방식으로 만들었다. 만약 빠르게 깃허브에서 문서를 만들고 싶다면 아래 👇 문서를 참조하면 좋을 것 같다. (사실 둘 다 비슷할 것 같긴 하다..)

https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository

Creating a pull request template for your repository - GitHub Docs

 🔥 Visual Code Studio 상에서 PULL_REQUEST_TEMPLATE.md 작성하기  🔥

 

1. `./github` 폴더를 가장 상위 폴더로 생성해준다.

 

2. `./github` 폴더 아래에 `PULL_REQUEST_TEMPLATE.md` 파일을 생성해준다.

폴더 구조

3. 파일을 생성했다면, 원하는 템플릿 양식을 마크 다운 형식으로 작성해주면 된다. 나의 경우 아래와 같은 형태로 작성했다. 

어떤 내용을 넣을까 고민하다가, 바리바리 개발을 할 때 꼭 필요할 내용을 중심으로 간결하게 작성하였다. 

 

마크다운 형식은 쓸 때마다 은근 헷갈리는 부분이 많다 ;-; 작성할 때마다 구글링 하는듯.. 마크다운 문법이 잘 정리된 블로그가 있길래 그냥 여기 첨부해두겠다! 

https://inpa.tistory.com/entry/MarkDown-%F0%9F%93%9A-%EB%A7%88%ED%81%AC%EB%8B%A4%EC%9A%B4-%EB%AC%B8%EB%B2%95-%F0%9F%92%AF-%EC%A0%95%EB%A6%AC

🏷️ 마크다운(MarkDown) 작성 문법 💯 총정리

 

 

4. 다 작성했다면 터미널 열어서 일반적으로 푸시하는 과정을 거쳐주면 된다!

git add .
git commit "docs: 풀 리퀘스트 템플릿 작성"
git push origin main

처음 배울 때부터 터미널로 푸시하는 걸로 배워서 터미널이 더 편하고 안심되는 1인..😮

 

끝!