Commit ee40206
authored
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
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
0 commit comments