Skip to content

Commit

Permalink
Add issue and pr templates (#80)
Browse files Browse the repository at this point in the history
  • Loading branch information
GoGiants1 authored Apr 14, 2024
1 parent 7dd4a4e commit b79ea26
Show file tree
Hide file tree
Showing 3 changed files with 85 additions and 0 deletions.
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: "\U0001F41B Bug Report"
about: "If something isn't working as expected \U0001F914."
title: ''
labels: bug
assignees: ''

---

**어떤 버그였나요?**
발생한 버그에 대한 간략한 설명을 적어주세요.

**버그 재현하는 법**
버그를 재현하는 방법을 자세히 단계별로 적어주세요.
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**원래 기대했던 상황**
A clear and concise description of what you expected to happen. (이런 버그가 발생하지 않았더라면 어떻게 동작하는게 맞았을까요?)

**스크린샷**
If applicable, add screenshots to help explain your problem.

**버그 발생 환경에 대한 정보들(please complete the following information):**
- OS: [Mac, Windows, Linux]

**해결 방안**
If you have a possible solution, please describe it.

**Additional context**
Add any other context about the problem here.
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
name: Feature Request Template
about: "For feature requests. Please search for existing issues first."

---

**문제를 간략히 설명해주세요**
(이 피처 요청으로 해결하고자 하는 문제에 대해 간결하게 설명해주세요. 해결하고자 하는 문제에 **포함되는 범위****제외되는 범위**를 명확하게 해주세요.)

**(선택 사항): 해결 방법 제안**
(선호하는 해결 방법에 대한 간결한 설명을 해주세요. 다음 사항을 주의해야 합니다:
* 기술적인 구현의 세부사항
* 설계 및 우리의 결정에 의한 trade-off
* 추후에 진행할 기능 개발을 위한 주의사항과 고려사항(이 방법을 선택할 경우, 어떤 문제가 발생할 수 있는지, 어떤 문제를 해결할 수 있는지, 어떤 문제를 해결할 수 없는지 등을 명확하게 설명해주세요. 예시: ORM으로의 이전 -> 코드 가독성 향상, 쿼리 최적화 힘들어짐, ORM의 특수한 문법에 대한 학습 필요 등)

여러 가지 해결 방법이 있는 경우, 각각을 별도로 제시해주세요. 각 방법의 비교는 맨 마지막에 남겨주세요.
36 changes: 36 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Pull Request

## 설명

PR에서 어떤 작업을 했는지 간략하게 설명해주세요. 다른 팀원들이 참고하면 좋을 context를 공유해주셔도 좋아요.

해결한 이슈가 있다면 아래에 이슈 번호들을 적어주세요.
Closes # issue numbers, separated by commas

## 어떤 종류의 PR인가요?

Please delete options that are not relevant.

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update

## 테스트는 어떤 방식으로 진행하셨나요?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

- [ ] Unit Test with pytest
- [ ] Integration Test with pytest
- [ ] Manual Test

## 체크리스트

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in **hard-to-understand areas**
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream modules

0 comments on commit b79ea26

Please sign in to comment.