Skip to content

Reporting a bug

Courtney Webster edited this page Aug 15, 2024 · 13 revisions

Choose your own 🐜 adventure!

This page outlines how to file a bug on the Python extension. If you are facing an issue with the Python Debugger, you can follow the same steps outlined below, but use "Python Debugger" as the extension name in the Report Issue command (Python Debugger: Report Issue...).

  • 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: If the command is missing, please follow the instructions below)

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.

Performance issue

Please attach a CPU profile of your running extensions to the issue after you create it.

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.


Short link to this page

Clone this wiki locally