:memo: Update the "new issue" templates (#749)

* :wrench: Update the "new issue" templates

* :green_heart: Trigger Travis CI after Travis migration

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index f9dc6709dace5e174a036668bbd4004ba554f049..d64ca6b4027c724008b2ba1989da2f95eb25835b 100644 (file)
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -7,29 +7,48 @@ assignees: ''
 
 ---
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+### Describe the bug
 
-**To Reproduce**
-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
+Write here a clear and concise description of what the bug is.
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+### To Reproduce
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+Steps to reproduce the behavior with a minimum self-contained file.
+
+Replace each part with your own scenario:
 
-**Environment:**
- - OS: [e.g. Linux / Windows / macOS]
- - FastAPI Version [e.g. 0.3.0], get it with:
+1. Create a file with:
 
 ```Python
-import fastapi
-print(fastapi.__version__)
+from fastapi import FastAPI
+
+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:
@@ -38,5 +57,6 @@ print(fastapi.__version__)
 python --version
 ```
 
-**Additional context**
+### Additional context
+
 Add any other context about the problem here.

diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index 7481d47965d432234f5b37eb620d3a63ebcd9ca8..15b94028ec9ec5e46c3160d9b7f1054b84db6d91 100644 (file)
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -7,14 +7,20 @@ assignees: ''
 
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I want to be able to [...] but I can't because [...]
+### Is your feature request related to a problem
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+Is your feature request related to a problem?
 
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features 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 [...]
+
+### 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.

diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
index 24a9284e3a9e86834397fa3e3da632c179740268..cc91b23395460e5543e551c59dc343639bdba921 100644 (file)
--- a/.github/ISSUE_TEMPLATE/question.md
+++ b/.github/ISSUE_TEMPLATE/question.md
@@ -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 [...]?
 
 Is it possible to [...]?
 
-**Additional context**
+### Additional context
+
 Add any other context or screenshots about the feature request here.