Add GitHub issue templates (Bug Report, Feature Request, Question)#1464
Open
StellaHuang95 wants to merge 2 commits intomicrosoft:mainfrom
Open
Add GitHub issue templates (Bug Report, Feature Request, Question)#1464StellaHuang95 wants to merge 2 commits intomicrosoft:mainfrom
StellaHuang95 wants to merge 2 commits intomicrosoft:mainfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.md)feature-request.md)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:
ms-python.python) versionThe Logs section directs users to the
"Python Environments"LogOutputChannel(created insrc/extension.ts) and the gear/filter icon in the Output panel to switch it to Trace — with theDeveloper: Set Log Level…command as an alternative — and suggests attaching long logs as.txtfiles.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
config.ymlincluded — blank issues remain enabled, matching Pylance's setup. Happy to add one (withblank_issues_enabled: falseand contact links) in a follow-up if preferred.https://github.com/microsoft/vscode-python-environments/issues/new/choose?template=bug-report.mdon this branch.