본문 바로가기
PlayGround/마실가실 리팩토링

[1년 후 마실가실] Issue 및 PR Template 설정과 Label 변경

by HJ0216 2024. 10. 9.

1년 전 진행했던 마실가실 프로젝트를 🛠️리팩토링하며 정리한 내용입니다.

 

최근에 1년후 마시가실에 커밋 규칙이 생겼습니다.

From me To me이지만, 습관을 잘 들여놓으면 좋기 때문이죠.

(혹시 누군가 찾아와 제 프로젝트에 대한 관심을 표현했을 때, 제 커밋 규칙과 함께 할 날이 올 수도 있습니다😎.)

 

커밋 규칙에 맞춰 developer에서 작업하고 commit하고 push하고 pr을 작성하다 문득.. 아주 문득.. Issue와 PR 컨트롤을 잘 하고 있나에 대한 고민이 생겼습니다. 추적할 수 있게 PR에 Issue 번호는 적는데, 뭔가 부족한 듯한 이 느낌..🥸

 

그래서 브랜치 전략도 바꾸고, Issue도 바꾸고, PR도 바꾸고, 그냥 다 바꾸고.. 바꿨습니다.

지금은 Issue로부터 Branch를 따고, Branch에서 작업을 한 후, PR을 작성하고 최종적으로 작업이 완료되면 branch를 삭제하는 형식으로 운영할 예정입니다.

 

Issue와 PR이 좀 더 기능 단위로 움직일 수 있도록 신경을 쓰면서 문득 통일감이 부족하다는 생각에 Template도 함께 적용시켜서 진행해보면 좋을 것 같아 이 글을 작성하게 되었습니다.

 

좋은 Template이 많아 상황에 맞게 요리조리 잘 수정해서 쓰면 좋을 것 같습니다.

  * 참고 자료의 블로그들을 참조하시면, 여러 Template를 만나보실 수 있습니다☺️!

 

 

🚨Main Branch에서 작업 🚨

 

1. Issue Template 생성

해당 Repository → Settings → General → Features → Set up templates → Add template:select → Custom Template

 

2. 라벨 수정

해당 Repository → Issues → Labels

(허전해 보이는 이유는 저도 이제 시작했기 때문입니다ㅎ_ㅎ)

 

3. PR Template 생성

해당 Repository → .github 폴더 → pull_request_template.md 직접 생성

 

 

 

🙋‍♀️

본 포스트는 공부 목적으로 작성하였습니다.
보시는 도중 잘못된 부분이나 개선할 부분이 있다면 댓글로 알려주시면 수정하도록 하겠습니다.

 

📑

참고 자료

https://didu-story.tistory.com/278

 

[Github] Github로 협업하는 방법 - repo 생성 시 할 일 (feat. 두번째 프로젝트 회고)

애플 디벨로퍼 아카데미에서 진행한 두번째 프로젝트가 끝이났다. 두번째 프로젝트는, 정말 느낀게 많은 프로젝트였다. 어쩌다가 내가 약간의 리드..?를 하게 되었는데 그 과정에서 내가 못했던

didu-story.tistory.com

https://2jinishappy.tistory.com/337

 

좋은 Pull Request를 만드는 방법과 PR Template 구성

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 For more information, see "About iss

2jinishappy.tistory.com

https://yangsosolife.tistory.com/107

 

[Git] Github Pull Request 템플릿 추가하기 (예시)

깃허브 레파지토리 하위에 .github/PULL_REQUEST_TEMPLATE.md를 추가하면 Pull Request를 등록할 때자동으로 양식을 만들어줍니다.   git-tutorial/.github/PULL_REQUEST_TEMPLATE.md at main · YangSSo51/git-tutorial깃 사용법

yangsosolife.tistory.com

https://dev-thinking.tistory.com/m/59

 

[GitHub] github template 등록하기(Issue, PR)

✏️ 프로젝트 초기 설정 할 때마다 Issue랑 PR 템플릿 등록하는 것도 매번 찾아봐야 해서 이것도 포스팅을 해놔야겠다는 생각이 들었다. 등록 방법을 외우는 것이 가장 좋지만 오랜만에 사용하면

dev-thinking.tistory.com

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

 

리포지토리에 대한 끌어오기 요청 템플릿 만들기 - GitHub Docs

리포지토리에 끌어오기 요청 템플릿을 추가하면 프로젝트 기여자가 끌어오기 요청 본문에서 템플릿의 콘텐츠를 자동으로 볼 수 있습니다.

docs.github.com