Skip to content

Reporting a bug

Brett Cannon edited this page Feb 28, 2022 · 13 revisions

Choose your own 🐜 adventure!

  • VS Code on the desktop?
    • Does the Python extension at least load?
  • VS Code on the web? (i.e. vscode.dev or github.dev)
  • raise RuntimeError("you should never reach here ...")

Desktop

The extension loads

  1. Run the Python: Report Issue... command from the command palette (note: the "Python" part of that command is IMPORTANT as this is not Help: Report Issue...; that's a different command!).
  2. Notice the new window that looks something like the following (the text in the "Steps to Reproduce" section may be different, but there will be some text prefilled):

Screenshot of the "Report Issue" window opened via the Python: Report Issue... command

  1. Fill in the details of the bug where there are XXX markers (you will have a chance to add screenshots and GIFs momentarily).
  2. Click the green Create on GitHub button.
  3. Attach any screenshots or GIFs to help explain the bug you are experiencing.
  4. Submit the issue on GitHub.

The extension won't even start

  1. Run the Help: Report Issue... command from the command palette.
  2. Notice the new window that looks something like the following (notice the empty "Steps to Reproduce" which separates this command from Python: Report Issue...):

Screenshot of the "Report Issue" window opened via the Help: Report Issue... command

  1. Set File on to An extension.
  2. Set Extension to Python.
  3. Fill in Title and Steps to Reproduce.
  4. Click the green Create on GitHub button.
  5. Add any screenshots or GIFs to the issue.
  6. Submit the issue on GitHub.

Web

Create a new issue by following this link.

Clone this wiki locally