|
| 1 | +name: Bug Report |
| 2 | +description: Something isn't working as expected |
| 3 | +labels: ["bug"] |
| 4 | +body: |
| 5 | + - type: markdown |
| 6 | + attributes: |
| 7 | + value: | |
| 8 | + Thanks for taking the time to report a bug! Please fill out the sections below so we can reproduce and fix it. |
| 9 | +
|
| 10 | + - type: textarea |
| 11 | + id: description |
| 12 | + attributes: |
| 13 | + label: Description |
| 14 | + description: What happened? What did you expect to happen? |
| 15 | + validations: |
| 16 | + required: true |
| 17 | + |
| 18 | + - type: textarea |
| 19 | + id: extension-logs |
| 20 | + attributes: |
| 21 | + label: Extension logs |
| 22 | + description: | |
| 23 | + Open the Output panel (`View > Output`) and select **FastAPI** from the dropdown. Paste the full log output here. |
| 24 | + render: text |
| 25 | + validations: |
| 26 | + required: true |
| 27 | + |
| 28 | + - type: input |
| 29 | + id: repo-link |
| 30 | + attributes: |
| 31 | + label: Repository link (if open source) |
| 32 | + description: A link to a public repo or minimal reproduction makes it much easier to debug. |
| 33 | + placeholder: "e.g. https://github.com/you/your-project" |
| 34 | + validations: |
| 35 | + required: false |
| 36 | + |
| 37 | + - type: textarea |
| 38 | + id: project-structure |
| 39 | + attributes: |
| 40 | + label: Project structure |
| 41 | + description: | |
| 42 | + Share a simplified directory tree of your project (especially the location of your FastAPI app, routers, and `pyproject.toml`). You can skip this if you provided a repo link above. |
| 43 | + placeholder: | |
| 44 | + my-project/ |
| 45 | + ├── pyproject.toml |
| 46 | + └── app/ |
| 47 | + ├── main.py |
| 48 | + └── routers/ |
| 49 | + └── users.py |
| 50 | + render: text |
| 51 | + validations: |
| 52 | + required: false |
| 53 | + |
| 54 | + - type: textarea |
| 55 | + id: app-definition |
| 56 | + attributes: |
| 57 | + label: FastAPI app and router setup |
| 58 | + description: | |
| 59 | + Share the relevant code — how your `FastAPI()` app is defined, how routers are created, and how `include_router` is called. You can skip this if you provided a repo link above. |
| 60 | + render: python |
| 61 | + validations: |
| 62 | + required: false |
| 63 | + |
| 64 | + - type: textarea |
| 65 | + id: pyproject |
| 66 | + attributes: |
| 67 | + label: pyproject.toml [tool.fastapi] section (if present) |
| 68 | + description: If you have a `[tool.fastapi]` section in your `pyproject.toml`, paste it here. |
| 69 | + render: toml |
| 70 | + validations: |
| 71 | + required: false |
| 72 | + |
| 73 | + - type: input |
| 74 | + id: vscode-version |
| 75 | + attributes: |
| 76 | + label: VS Code version |
| 77 | + description: Run `code --version` or check Help > About. |
| 78 | + placeholder: "e.g. 1.97.0" |
| 79 | + validations: |
| 80 | + required: true |
| 81 | + |
| 82 | + - type: input |
| 83 | + id: extension-version |
| 84 | + attributes: |
| 85 | + label: FastAPI extension version |
| 86 | + description: Found in the Extensions panel next to "FastAPI". |
| 87 | + placeholder: "e.g. 0.1.0" |
| 88 | + validations: |
| 89 | + required: true |
| 90 | + |
| 91 | + - type: input |
| 92 | + id: python-version |
| 93 | + attributes: |
| 94 | + label: Python version |
| 95 | + description: Run `python --version` in your terminal. |
| 96 | + placeholder: "e.g. 3.12.2" |
| 97 | + validations: |
| 98 | + required: true |
| 99 | + |
| 100 | + - type: input |
| 101 | + id: fastapi-version |
| 102 | + attributes: |
| 103 | + label: FastAPI version |
| 104 | + description: Run `pip show fastapi` or check your `pyproject.toml`. |
| 105 | + placeholder: "e.g. 0.115.0" |
| 106 | + validations: |
| 107 | + required: true |
| 108 | + |
| 109 | + - type: input |
| 110 | + id: os |
| 111 | + attributes: |
| 112 | + label: Operating system |
| 113 | + placeholder: "e.g. macOS 15.3, Ubuntu 24.04, Windows 11" |
| 114 | + validations: |
| 115 | + required: true |
0 commit comments