Git: PR + 이슈 작성하기(Pull Request)

---

Git: PR + 이슈 작성하기(Pull Request)

협업 중심의 개발 환경에서는 코드 작성뿐 아니라 PR(Pull Request)와 이슈 관리를 어떻게 하느냐도 굉장히 중요합니다. PR과 이슈는 단순한 기록이 아니라, 코드 리뷰와 소통을 돕는 중요한 도구이기 때문입니다.

이 포스트에서는 효율적인 PR + 이슈 작성법을 함께 정리해볼게요.

---

1. 이슈(Issue) 작성하기

이슈는 버그 제보, 기능 제안, 개선 아이디어 등 작업의 출발점이 됩니다. 깃헙(GitHub)을 기준으로 설명할게요.

오른쪽 초록색 new issue 버튼을 눌러서 이슈 생성 가능

✏️ 좋은 이슈 작성 가이드

• 제목은 명확하게: 간결하면서도 작업 내용을 알 수 있도록
• 예: [버그] 로그인 시 500 에러 발생
• 본문에는 다음을 포함해요

### 설명
- 어떤 문제가 발생했는지 또는 어떤 기능을 제안하는지 작성

### 재현 방법 (버그일 경우)
1. 로그인 페이지 접속
2. 아이디/비번 입력 후 로그인 버튼 클릭
3. 500 에러 발생

### 기대 동작
- 정상적으로 홈 화면으로 이동

### 환경
- OS: macOS
- 브라우저: Chrome 123.0

• 라벨(Label)과 마일스톤(Milestone)을 설정해두면 팀원 간 공유가 쉬워져요.

---

2. Pull Request(PR) 작성하기

코드를 푸시했다면, 다음은 PR입니다. 리뷰어가 코드를 이해하고 피드백을 줄 수 있도록 맥락과 목적이 잘 드러나야 해요.

오른쪽 초록색 new pull request 버튼을 눌러서 이슈 생성 가능

✅ 좋은 PR 작성 체크리스트

• 제목은 이슈와 연결되게
• 예: [#123] 로그인 시 발생하는 500 에러 수정
• 본문 예시

### 변경 사항
- 로그인 시 발생하던 500 에러 수정
- 백엔드 API 요청 시 누락된 토큰 추가

### 관련 이슈
- close #123

### 스크린샷 (UI 변경 시)
- Before / After 이미지 첨부

### 체크리스트
- [x] 단위 테스트 통과
- [x] QA 완료

• 작은 단위로 PR 보내기
  너무 많은 변경사항이 한 번에 들어가면 리뷰어도, 미래의 나도 힘들어요. 의미 있는 최소 단위로 쪼개보세요.

3. 이슈와 PR을 연결하는 팁

• PR 본문에 close #이슈번호를 적으면, PR이 머지될 때 자동으로 이슈가 닫혀요.
• 커밋 메시지에도 fixes #이슈번호 같은 표현을 넣을 수 있어요.

---

✍️ 정리하며

PR과 이슈는 단순히 해야 할 일을 기록하는 게 아니라, 팀원과의 커뮤니케이션 도구입니다. 깔끔한 이슈와 명확한 PR은 프로젝트의 신뢰도를 높이고, 코드의 품질을 끌어올리는 데 큰 도움이 돼요.

다음부터는 코드를 작성한 후 꼭 스스로에게 물어보세요:

"이슈는 명확하게 썼나?"
"이 PR을 다른 사람이 봐도 이해할 수 있을까?"