깃 협업이 중요한 이유
혼자 개발할 경우엔 자기가 어떤 기능을 구현을 완료했고, 어떤 문제가 있는지 잘 알기 때문에 깃 관리의 필요성이 체감되지 않는다.
하지만 협업을 하고, 개발 팀 규모가 커질 수록 자신이 하고있는 일을 적극적으로 표시할 수 있어야 원할한 팀워크가 진행된다.
그래서 협업에서 가장 기초적으로 신경써야할 부분은, Git 관리라고 생각한다.
깃 이슈 관리, 깃 풀리퀘스트 관리, 깃 코드 리뷰, 깃 커밋 메시지 컨벤션, 깃 브랜치 전략 등 다양한 약속 중 이번 게시글에선 깃 이슈와 풀리퀘스트 템플릿에 관하여 글을 작성하고자 한다
템플릿을 도입한 이유
- 프로젝트에서 기능별이나, 수정이 필요한 이슈를 생성하고, 이슈에 대한 브랜치를 생성해서 해결한 뒤 PR을 날리기로 결정
- 템플릿을 정하지 않으면 매번 이슈나 PR을 생성할 때 마다 중요한 정보를 깜빡하고 못 적을 경우가 많다.
- 템플릿을 통해 통일된 정보를 이슈마다 볼 수 있으므로 프로젝트 관리 측면에서 좋다.
템플릿 생성하는 방법
깃헙에서 템플릿 생성
이슈 템플릿
방법 1. 깃 프로젝트에서 Settings → Set up templates 클릭
방법 2. 또는 직접 프로젝트의 최상단 디렉토리에서 .github 폴더를 생성한 뒤 ISSUE_TEMPLATE 폴더를 생성한 후, 아래에 이슈 템플릿으로 사용할 md 파일 생성
기능 추가 이슈인 Feature request 템플릿 선택
원하는 템플릿 제목과 어디에 쓰이는 지, 템플릿의 내용은 무엇인지 markdown 문법으로 작성
이슈를 생성해보자!
이슈 템플릿으로 시작했을 때 모습
이슈에 대해 라벨을 이쁘게 꾸며주면 어떤 이슈인지 제목과 라벨만으로 느낌이 확 온다! 라벨도 새로 만들어줘서 세팅해주면 좋다
생성된 이슈를 확인해보자 (이쁜 라벨!)
작업 내용은 todo 처럼 관리해주면 위와 같이 n of m tasks 처럼 진행도를 표시해준다
풀리퀘스트 템플릿 생성
아까 생성해준 .github 폴더 아래에 PULL_REQUEST_TEMPLATE.md 라는 이름의 파일을 생성해서 내용을 적어주자
잘 생성했는지 테스트해보자
꿀팁 ‼️
closes #{이슈번호} 를 적어줄 경우 merge될 때 이슈가 자동으로 닫힌다
템플릿 공유 (좋아요♥️ 부탁합니다!)
- 이슈 템플릿
---
name: Feature request
about: Suggest an idea for this project
title: "[FEAT]"
labels: ''
assignees: ''
---
---
name: Feature Template
about: 기능 추가
title: "[FEAT]"
labels: ''
assignees: ''
---
## ⚙️어떤 기능인가요?
> 추가하려는 기능에 대해 간결하게 설명해주세요
## 🔎작업 상세 내용
- [ ] TODO
- [ ] TODO
- [ ] TODO
## 💫참고할만한 자료(선택)
- 풀리퀘스트 템플릿
## #️⃣연관된 이슈
> ex) #이슈번호, #이슈번호
## 📝작업 내용
> 이번 PR에서 작업한 내용을 간략히 설명해주세요(이미지 첨부 가능)
### 스크린샷 (선택)
## 💬리뷰 요구사항(선택)
> 리뷰어가 특별히 봐주었으면 하는 부분이 있다면 작성해주세요
>
> ex) 메서드 XXX의 이름을 더 잘 짓고 싶은데 혹시 좋은 명칭이 있을까요?