Skip to content

Commit 556227c

Browse files
committed
chore(github): update issue and pr templates
1 parent 46a0a3a commit 556227c

File tree

4 files changed

+92
-0
lines changed

4 files changed

+92
-0
lines changed
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: Bug report 🐛
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
## Describe the bug
11+
12+
A clear and concise description of what the bug is.
13+
14+
## To Reproduce
15+
16+
Steps to reproduce the behavior:
17+
18+
1. Go to '...'
19+
2. Click on '....'
20+
3. Scroll down to '....'
21+
4. See error
22+
23+
## Expected behavior
24+
25+
A clear and concise description of what you expected to happen.
26+
27+
## Configuration
28+
29+
```shell
30+
# use `pip freeze` to list all deps
31+
pip freeze
32+
```
33+
34+
- Python version:
35+
- OS version:
36+
- deps version:
37+
- ...
38+
39+
## Additional context
40+
41+
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
contact_links:
2+
- name: I have a question 🤔
3+
url: https://github.com/WSH032/fastapi-proxy-lib/discussions
4+
about: If you have any question that's not clearly a bug, please open a discussion first.
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Feature request 💡
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
## Have you discussed it?
11+
12+
- [ ] I have discussed this feature request in discussions, and developers ask me directly to create an issue here.
13+
14+
## Describe your feature request
15+
16+
A clear and concise description of what the feature is.
17+
18+
## Is your feature request related to a problem? Please describe
19+
20+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
21+
22+
## Describe the solution you'd like
23+
24+
A clear and concise description of what you want to happen.
25+
26+
## Describe alternatives you've considered
27+
28+
A clear and concise description of any alternative solutions or features you've considered.
29+
30+
## Additional context
31+
32+
Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!-- copy from: https://github.com/encode/starlette/blob/master/.github/pull_request_template.md -->
2+
3+
<!-- Thanks for contributing 💚
4+
Given this is a project maintained by volunteers, please read this template to not waste your time, or ours! 😁 -->
5+
6+
# Summary
7+
8+
<!-- Write a small summary about what is happening here. -->
9+
10+
# Checklist
11+
12+
- [ ] I've read `CONTRIBUTING.md`.
13+
- [ ] I understand that this PR may be closed in case there was no previous discussion. (This doesn't apply to typos!)
14+
- [ ] I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change.
15+
- [ ] I've updated the documentation accordingly.

0 commit comments

Comments
 (0)