Skip to content

Add GitHub issue templates (Bug Report, Feature Request, Question)#1464

Open
StellaHuang95 wants to merge 2 commits intomicrosoft:mainfrom
StellaHuang95:issueTemplates
Open

Add GitHub issue templates (Bug Report, Feature Request, Question)#1464
StellaHuang95 wants to merge 2 commits intomicrosoft:mainfrom
StellaHuang95:issueTemplates

Conversation

@StellaHuang95
Copy link
Copy Markdown
Contributor

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 (#1180, #1181, #1182, #1341)
Python version & distribution Anaconda / system / Store Python behave differently
Environment manager in use Conda / poetry / pipenv / pyenv reports (#1454, #1180, #1182–1185, #1206)
Shell Activation bugs are shell-specific (#1325 bash, #1158 fish, #1341 PowerShell)
Remote / container scenario WSL / SSH / Dev Container / Codespaces reports (#1357, #1337, #1027)
Workspace type Multi-root / mono-repo is a distinct code path (#1039, #1099, #1145, #1200)
Regression? last working version Enables bisect for "this started recently" reports (#1124, #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 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant