GitHub PR template 적용하기

1. 협업할 때 PR(Pull Requset) 를 사용하는 이유

코드 리뷰와 협업의 핵심 도구인 Pull Request는 팀 프로젝트의 품질을 높이고 안정적인 개발을 가능하게 한다.

개발자가 자신의 작업 브랜치에서 변경사항을 만들고, 이를 메인 브랜치에 병합하기 전에 다른 팀원들의 검토를 받을 수 있다.

이 과정에서 코드의 버그를 조기에 발견하고, 코딩 스타일을 일관되고 유지하며, 더 나은 구현 방법에 대한 토론이 가능해진다.

또한, PR을 통해 변경사항을 문서화하고 추적할 수 있어, 나중에 특정 기능이나 버그 수정의 히스토리를 쉽게 확인할 수 있다.

요약하면 교차 검증!

 

2. PR Template 적용

Creating a pull request template for your repository - GitHub Docs

 

PR을 생성할 때 팀원 모두가 공유하는 양식이 있다면, 효율적인 협업이 가능해진다.

- docs/pull_request_template.md

## Summary
<!-- 해당 PR에 어떤 작업이 포함됐는지 요약해주세요 -->
<!-- merge시 관련 이슈가 자동으로 close 되도록 이슈 번호를 작성해주세요 -->
- closed #

## Key Changes
<!-- 주요 수정사항을 기재해주세요 -->

## Testing
<!-- 해당 작업을 확인할 수 있는 방법을 기재해주세요 -->
<!-- 전/후 스크린샷을 첨부하기도 합니다 -->

## To Reviewers
<!-- 리뷰어에게 전달하거나 논의하고 싶은 내용을 기재해주세요 -->

 

해당 파일만 생성해주면, PR 생성시 자동으로 아래의 template이 적용된다.

 

3. issue template 적용

Github의 issue 는 프로젝트 관리와 협업을 위한 핵심적인 도구다.

issue는 다음과 같은 주요 기능과 특징을 갖고 있다.

주요 기능

• 작업 단위 관리: 버그 리포트, 새로운 기능 요청, 개선사항 등을 이슈로 생성하여 추적할 수 있다.
• 토론과 협업: 팀원들과 특정 작업에 대해 논의하고 피드백을 주고받을 수 있다.
• 작업 할당: 특정 이슈를 팀원에게 할당하여 책임자를 명확히 할 수 있다. 

issue 의 구성 요소

• 제목과 설명: 작업의 내용을 명확하게 설명하는 제목과 상세 설명
• 라벨: 이슈의 성격을 분류하는 태그 (예: [Feat], [Bug], [Docs], [Minor], [Build], [Refactor], [Fix])
• 마일스톤: 여러 이슈를 그룹화하여 프로젝트의 진행 상황을 추적
• 담당자: 해당 작업을 담당할 팀원 지정

활용 방법

• 브랜치 연동: 각 이슈에 대응하는 feature 브랜치를 생성하여 작업을 진행한다.
• 자동화된 연결: PR(Pull Request)에서 특정 키워드를 사용하면 자동으로 이슈가 연결되고 관리된다.

 

issue template 적용

- .github/ISSUE_TEMPLATE/feature-template.md

---
name: Feature Template
about: 기능 개발을 위한 템플릿
title: "[Feat]"
labels: feat
assignees: ''

---

## Description
<!-- 개발하고자 하는 기능에 대해 설명해주세요 -->

## TODO
<!-- 개발을 위해 해야 할 일을 작성해주세요 -->
- [ ]

## Reference
<!-- 참고 자료가 있다면 작성해주세요 -->

## Additional context
<!-- 추가적인 내용이 있다면 작성해주세요 -->

 

해당 파일을 생성해주면, 역시 이슈 작성시에 template이 적용된다.

 

4. Merge Commit message

merge 할 때 commit message 도 통일하면 좋다

- 예시 

[Merge] Merge pull request #{pr번호} from CodeBloom/{커밋유형}/#{이슈번호}