Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
115 changes: 115 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
name: Bug Report
description: Something isn't working as expected
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report a bug! Please fill out the sections below so we can reproduce and fix it.

- type: textarea
id: description
attributes:
label: Description
description: What happened? What did you expect to happen?
validations:
required: true

- type: textarea
id: extension-logs
attributes:
label: Extension logs
description: |
Open the Output panel (`View > Output`) and select **FastAPI** from the dropdown. Paste the full log output here.
render: text
validations:
required: true

- type: input
id: repo-link
attributes:
label: Repository link (if open source)
description: A link to a public repo or minimal reproduction makes it much easier to debug.
placeholder: "e.g. https://github.com/you/your-project"
validations:
required: false

- type: textarea
id: project-structure
attributes:
label: Project structure
description: |
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.
placeholder: |
my-project/
├── pyproject.toml
└── app/
├── main.py
└── routers/
└── users.py
render: text
validations:
required: false

- type: textarea
id: app-definition
attributes:
label: FastAPI app and router setup
description: |
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.
render: python
validations:
required: false

- type: textarea
id: pyproject
attributes:
label: pyproject.toml [tool.fastapi] section (if present)
description: If you have a `[tool.fastapi]` section in your `pyproject.toml`, paste it here.
render: toml
validations:
required: false

- type: input
id: vscode-version
attributes:
label: VS Code version
description: Run `code --version` or check Help > About.
placeholder: "e.g. 1.97.0"
validations:
required: true

- type: input
id: extension-version
attributes:
label: FastAPI extension version
description: Found in the Extensions panel next to "FastAPI".
placeholder: "e.g. 0.1.0"
validations:
required: true

- type: input
id: python-version
attributes:
label: Python version
description: Run `python --version` in your terminal.
placeholder: "e.g. 3.12.2"
validations:
required: true

- type: input
id: fastapi-version
attributes:
label: FastAPI version
description: Run `pip show fastapi` or check your `pyproject.toml`.
placeholder: "e.g. 0.115.0"
validations:
required: true

- type: input
id: os
attributes:
label: Operating system
placeholder: "e.g. macOS 15.3, Ubuntu 24.04, Windows 11"
validations:
required: true
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
blank_issues_enabled: false
contact_links:
- name: Security Contact
about: Please report security vulnerabilities to security@tiangolo.com
- name: Feature Request
about: To suggest an idea or ask about a feature, please start a discussion.
url: https://github.com/fastapi/fastapi-vscode/discussions/categories/questions
Loading