깃허브 이슈 및 PR 작성 가이드

깃허브 이슈 및 PR 작성 가이드

깃허브에서 이슈와 PR(Pull Request) 작성 시 필요한 템플릿과 작성 가이드를 제공합니다.

---

📝 이슈 작성 템플릿

1. 기능 이슈 템플릿

목적

• 기능 추가 또는 개선 사항에 대한 명확한 설명을 작성합니다.

구현

• 기능 구현 계획 및 세부 내용을 기록합니다.

설명 (Optional)

• 추가적으로 필요한 설명을 작성합니다.

---

2. 리팩토링 이슈 템플릿

리팩토링 이유

• 리팩토링이 필요한 이유와 배경을 작성합니다.

리팩토링 계획

• 구체적인 리팩토링 진행 방법을 기록합니다.

---

3. 버그 이슈 템플릿

상황

• 문제가 발생한 상황과 증상을 자세히 설명합니다.

해결 방법

• 문제를 해결하기 위한 계획이나 아이디어를 작성합니다.

---

🔀 PR 작성 템플릿

작성 가이드

1. PR 제목은 **"이번 작업을 한 문장의 메시지로 요약한 것"**으로 설정합니다.
2. 완료된 작업 목록과 구현 결과를 기록합니다.
3. 동작 결과가 있다면 스크린샷 또는 동영상을 포함합니다.
4. PR 작성 후 충돌 여부를 반드시 확인합니다.

템플릿 구조

## 🛠️ 연관 이슈
- 관련된 이슈 번호 또는 링크를 추가하세요.  
  e.g., **Closes #123**

---

## ✨ 주요 작업
- 완료된 작업 목록을 작성합니다.  
  e.g.,
  - 회원가입 기능 구현
  - UI 수정 (다국어 지원 추가)
  - 성능 최적화 (이미지 로딩 개선)

---

## 🎯 구현 결과
- 동작 결과를 확인할 수 있는 내용을 작성합니다.
- **스크린샷** 또는 동영상을 포함하면 리뷰에 도움이 됩니다.

---

## 💡 비고 (Optional)
- 추가로 참고해야 할 사항이나 리뷰어에게 전할 메시지를 작성합니다.  
  e.g., **"테스트 코드 작성이 필요합니다."**