Skip to content

Commit ee40206

Browse files
Add GitHub issue templates (Bug Report, Feature Request, Question) (microsoft#1464)
## What Adds an `.github/ISSUE_TEMPLATE/` folder with three Markdown templates so users filing issues from the repo's "New issue" page get a template chooser instead of a blank textarea: - **Bug Report** (`bug-report.md`) - **Feature Request** (`feature-request.md`) - **Question** (`question.md`) ## Why The repo currently has no issue templates, so every new issue starts from an empty body. Triage consistently spends extra round-trips asking for the same basics (extension version, OS, shell, active environment manager, remote vs. local, repro steps, logs). The new templates front-load that information and steer misfiled issues toward Discussions and sibling repos. ## Bug Report fields (and why they're there) Fields were chosen by reviewing recent and historical bug reports in this repo. Each one corresponds to information that has repeatedly blocked or slowed triage: | Field | Motivating issues | |---|---| | Python Environments ext version | Every report; needed for regression detection | | Python extension (`ms-python.python`) version | Version-skew between the two extensions | | VS Code version | Standard | | OS and version | Path / exec-policy bugs are OS-specific (microsoft#1180, microsoft#1181, microsoft#1182, microsoft#1341) | | Python version & distribution | Anaconda / system / Store Python behave differently | | Environment manager in use | Conda / poetry / pipenv / pyenv reports (microsoft#1454, microsoft#1180, microsoft#1182–1185, microsoft#1206) | | Shell | Activation bugs are shell-specific (microsoft#1325 bash, microsoft#1158 fish, microsoft#1341 PowerShell) | | Remote / container scenario | WSL / SSH / Dev Container / Codespaces reports (microsoft#1357, microsoft#1337, microsoft#1027) | | Workspace type | Multi-root / mono-repo is a distinct code path (microsoft#1039, microsoft#1099, microsoft#1145, microsoft#1200) | | Regression? last working version | Enables bisect for "this started recently" reports (microsoft#1124, microsoft#1325) | The Logs section directs users to the `"Python Environments"` `LogOutputChannel` (created in `src/extension.ts`) and the gear/filter icon in the Output panel to switch it to Trace — with the `Developer: Set Log Level…` command as an alternative — and suggests attaching long logs as `.txt` files. ## Feature Request & Question Kept intentionally minimal (matches Pylance). The Question template points users to [Discussions](https://github.com/microsoft/vscode-python/discussions/categories/q-a) and the sibling repos (Python, Pylance, Jupyter, Python Debugger) to deflect misfiled issues. ## Notes - No `config.yml` included — blank issues remain enabled, matching Pylance's setup. Happy to add one (with `blank_issues_enabled: false` and contact links) in a follow-up if preferred. - Templates only take effect once merged to the default branch. Preview before merging: `https://github.com/microsoft/vscode-python-environments/issues/new/choose?template=bug-report.md` on this branch. - No code changes; docs/repo-infra only.
1 parent 3c072d1 commit ee40206

3 files changed

Lines changed: 112 additions & 0 deletions

File tree

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
Please search existing issues first to avoid creating duplicates:
12+
https://github.com/microsoft/vscode-python-environments/issues
13+
-->
14+
15+
## Environment data
16+
17+
<!--
18+
To find extension versions, open the VS Code Extensions panel and locate each
19+
extension from the list of installed extensions. The version appears next to the name.
20+
-->
21+
22+
- Python Environments extension version: XXX
23+
- Python extension (`ms-python.python`) version: XXX
24+
- VS Code version (Help → About): XXX
25+
- OS and version: XXX
26+
- Python version (& distribution if applicable, e.g. Anaconda): XXX
27+
- Environment manager in use (`venv` / `conda` / `pyenv` / `poetry` / `pipenv` / `system` / `uv` / other): XXX
28+
- Shell (bash / zsh / fish / pwsh / cmd / other): XXX
29+
- Remote / container scenario (none / WSL / SSH Remote / Dev Container / Codespaces): XXX
30+
- Workspace type (single folder / multi-root / mono-repo): XXX
31+
- Is this a regression? If yes, last known working extension version: XXX
32+
33+
## Repro Steps
34+
35+
<!--
36+
Please list the minimal steps needed to reproduce the issue, starting from a fresh
37+
VS Code window when possible. If the issue only reproduces with specific workspace
38+
contents (e.g. a `pyproject.toml`, `.venv`, `environment.yml`, `Pipfile`, `poetry.lock`,
39+
`.python-version`), please share a minimal example or describe the layout.
40+
41+
If the bug only reproduces with certain settings, please include the relevant entries
42+
from your `settings.json` (user and/or workspace).
43+
-->
44+
45+
1. XXX
46+
47+
## Expected behavior
48+
49+
XXX
50+
51+
## Actual behavior
52+
53+
XXX
54+
55+
## Logs
56+
57+
<!--
58+
Please include logs from the "Python Environments" output channel.
59+
60+
To capture verbose logs:
61+
1. Open the Output panel (View → Output).
62+
2. Select "Python Environments" from the channel dropdown in the upper-right.
63+
3. Click the gear / filter icon at the top of the Output panel and set the level to "Trace".
64+
(Alternatively: Command Palette → "Developer: Set Log Level…" → "Python Environments" → "Trace".)
65+
4. Reproduce the issue.
66+
5. Paste the relevant output below, or save it to a `.txt` file and attach it to the issue (preferred for long logs).
67+
68+
If the issue is about terminal activation, please also paste the exact terminal
69+
output where the problem occurs.
70+
-->
71+
72+
```
73+
XXX
74+
```
75+
76+
## Additional context
77+
78+
<!--
79+
Anything else that may help us reproduce: screenshots, videos, related issues,
80+
links to your project, workarounds you've tried, etc.
81+
-->
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
<!-- Please search existing feature requests to avoid creating duplicates. -->
11+
12+
<!-- Describe the feature you'd like. -->

.github/ISSUE_TEMPLATE/question.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Question
3+
about: Ask a question about this project.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
Please search existing issues to avoid creating duplicates.
12+
For general Python-in-VS-Code usage questions, consider starting a discussion at
13+
https://github.com/microsoft/vscode-python/discussions/categories/q-a
14+
or checking the issues in the following related repositories:
15+
- Python extension: https://github.com/microsoft/vscode-python/issues
16+
- Pylance: https://github.com/microsoft/pylance-release/issues
17+
- Jupyter: https://github.com/microsoft/vscode-jupyter/issues
18+
- Python Debugger: https://github.com/microsoft/vscode-python-debugger/issues
19+
-->

0 commit comments

Comments
 (0)