Skip to content

Issuse, PR 템플릿 도입 제안 #295

@leeesooha

Description

@leeesooha

제안 이유 : 현재 Issue와 PR을 작성할 때 각자가 개별적인 형식을 사용하고 있어 가독성과 일관성이 부족한 것 같습니다. Issue와 PR은 기록을 검색하고 참고하는 데에도 활용됩니다. 따라서, 통일된 템플릿을 사용하면 가독성을 높이고, 필요한 정보를 빠짐없이 포함할 수 있어 더 좋을 것 같습니다.

  • PR Template 1개
  • Issue Template 2개 (버그수정,기능제안)

PR Template

# 🚀 PR 제목
[기능/버그/개선] 간단한 설명

## 📝 설명
- 이 PR이 어떤 문제를 해결하거나 어떤 기능을 추가하는지 설명해주세요.
## 🔗 이슈 링크
- 관련된 이슈 번호가 있다면 여기에 링크해주세요. (예: #이슈번호)

## ✨ 변경 사항
- 이 PR에서 변경된 주요 사항을 나열해주세요.
- 코드 변경, 새로운 기능 추가, 버그 수정 등

## 📚 추가 정보
- 리뷰어에게 전달할 추가 정보가 있다면 여기에 작성해주세요.
- 스크린샷, GIF, 관련 문서 링크 등

## ✅ 체크리스트
- [ ] 테스트를 완료했나요?

Issue Template (Bug report)

# 🐛 버그 설명
- 버그에 대한 간단한 설명을 작성해주세요.

## 🔍 재현 방법
1. 첫 번째 단계
2. 두 번째 단계
3. ...

## 🎯 예상 동작
- 정상적으로 동작했을 때 기대되는 결과를 설명해주세요.

## 🚨 실제 동작
- 실제로 발생한 문제를 설명해주세요.

## 📸 스크린샷 또는 로그
- 문제를 설명하는 데 도움이 되는 스크린샷이나 로그를 첨부해주세요.

## 📚 추가 정보
- 버그와 관련된 추가 정보가 있다면 여기에 작성해주세요.

Issue Template (feature)

# ✨ 기능 설명
- 추가하고자 하는 기능에 대한 간단한 설명을 작성해주세요.

## 🎯 필요성
- 이 기능이 왜 필요한지 설명해주세요.
- 현재 어떤 문제를 해결할 수 있는지

## 🛠️ 구현 방안
- 이 기능을 어떻게 구현할지에 대한 아이디어나 계획을 설명해주세요.
- 기술 스택, 라이브러리, API 등

## 🚀 예상 결과
- 이 기능이 추가되면 어떤 결과를 기대할 수 있는지 설명해주세요.

## 📚 추가 정보
- 기능과 관련된 추가 정보가 있다면 여기에 작성해주세요.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions