mirror of
https://github.com/rjNemo/fastapi
synced 2026-06-11 21:16:45 +00:00
📝 Update the "new issue" templates (#749)
* 🔧 Update the "new issue" templates * 💚 Trigger Travis CI after Travis migration
This commit is contained in:
parent
c1788a25c7
commit
35510a5ea7
3 changed files with 60 additions and 27 deletions
56
.github/ISSUE_TEMPLATE/bug_report.md
vendored
56
.github/ISSUE_TEMPLATE/bug_report.md
vendored
|
|
@ -7,29 +7,48 @@ assignees: ''
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Describe the bug**
|
### Describe the bug
|
||||||
A clear and concise description of what the bug is.
|
|
||||||
|
|
||||||
**To Reproduce**
|
Write here a clear and concise description of what the bug is.
|
||||||
Steps to reproduce the behavior:
|
|
||||||
1. Create a file with '...'
|
|
||||||
2. Add a path operation function with '....'
|
|
||||||
3. Open the browser and call it with a payload of '....'
|
|
||||||
4. See error
|
|
||||||
|
|
||||||
**Expected behavior**
|
### To Reproduce
|
||||||
A clear and concise description of what you expected to happen.
|
|
||||||
|
|
||||||
**Screenshots**
|
Steps to reproduce the behavior with a minimum self-contained file.
|
||||||
If applicable, add screenshots to help explain your problem.
|
|
||||||
|
|
||||||
**Environment:**
|
Replace each part with your own scenario:
|
||||||
- OS: [e.g. Linux / Windows / macOS]
|
|
||||||
- FastAPI Version [e.g. 0.3.0], get it with:
|
1. Create a file with:
|
||||||
|
|
||||||
```Python
|
```Python
|
||||||
import fastapi
|
from fastapi import FastAPI
|
||||||
print(fastapi.__version__)
|
|
||||||
|
app = FastAPI()
|
||||||
|
|
||||||
|
|
||||||
|
@app.get("/")
|
||||||
|
def read_root():
|
||||||
|
return {"Hello": "World"}
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Open the browser and call the endpoint `/`.
|
||||||
|
4. It returns a JSON with `{"Hello": "World"}`.
|
||||||
|
5. But I expected it to return `{"Hello": "Sara"}`.
|
||||||
|
|
||||||
|
### Expected behavior
|
||||||
|
|
||||||
|
Add a clear and concise description of what you expected to happen.
|
||||||
|
|
||||||
|
### Screenshots
|
||||||
|
|
||||||
|
If applicable, add screenshots to help explain your problem.
|
||||||
|
|
||||||
|
### Environment
|
||||||
|
|
||||||
|
- OS: [e.g. Linux / Windows / macOS]
|
||||||
|
- FastAPI Version [e.g. 0.3.0], get it with:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python -c "import fastapi; print(fastapi.__version__)"
|
||||||
```
|
```
|
||||||
|
|
||||||
- Python version, get it with:
|
- Python version, get it with:
|
||||||
|
|
@ -38,5 +57,6 @@ print(fastapi.__version__)
|
||||||
python --version
|
python --version
|
||||||
```
|
```
|
||||||
|
|
||||||
**Additional context**
|
### Additional context
|
||||||
|
|
||||||
Add any other context about the problem here.
|
Add any other context about the problem here.
|
||||||
|
|
|
||||||
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
|
|
@ -7,14 +7,20 @@ assignees: ''
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Is your feature request related to a problem? Please describe.**
|
### Is your feature request related to a problem
|
||||||
A clear and concise description of what the problem is. Ex. I want to be able to [...] but I can't because [...]
|
|
||||||
|
|
||||||
**Describe the solution you'd like**
|
Is your feature request related to a problem?
|
||||||
A clear and concise description of what you want to happen.
|
|
||||||
|
|
||||||
**Describe alternatives you've considered**
|
Add a clear and concise description of what the problem is. Ex. I want to be able to [...] but I can't because [...]
|
||||||
A clear and concise description of any alternative solutions or features you've considered.
|
|
||||||
|
### The solution you would like
|
||||||
|
|
||||||
|
Add a clear and concise description of what you want to happen.
|
||||||
|
|
||||||
|
### Describe alternatives you've considered
|
||||||
|
|
||||||
|
Add a clear and concise description of any alternative solutions or features you've considered.
|
||||||
|
|
||||||
|
### Additional context
|
||||||
|
|
||||||
**Additional context**
|
|
||||||
Add any other context or screenshots about the feature request here.
|
Add any other context or screenshots about the feature request here.
|
||||||
|
|
|
||||||
11
.github/ISSUE_TEMPLATE/question.md
vendored
11
.github/ISSUE_TEMPLATE/question.md
vendored
|
|
@ -7,11 +7,18 @@ assignees: ''
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Description**
|
### First check
|
||||||
|
|
||||||
|
* [ ] I used the GitHub search to find a similar issue and didn't find it.
|
||||||
|
* [ ] I searched the FastAPI documentation, with the integrated search.
|
||||||
|
* [ ] I already searched in Google "How to X in FastAPI" and didn't find any information.
|
||||||
|
|
||||||
|
### Description
|
||||||
|
|
||||||
How can I [...]?
|
How can I [...]?
|
||||||
|
|
||||||
Is it possible to [...]?
|
Is it possible to [...]?
|
||||||
|
|
||||||
**Additional context**
|
### Additional context
|
||||||
|
|
||||||
Add any other context or screenshots about the feature request here.
|
Add any other context or screenshots about the feature request here.
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue