Report an Issue

InterSystems ObjectScript for VS Code consists of three collaborating VS Code extensions. This modular architecture also means there are three different GitHub repositories where issues can be created. Fortunately, VS Code provides a convenient interface to help with the task. (Note: you must have a GitHub account to report an issue through GitHub.)

To create a GitHub issue from within the VS Code interface, perform the following steps:

1. From the Help menu in VS Code select Report Issue. Alternatively, open the Command Palette and run the Help: Report Issue... command.

2. When the dialog appears, use the first drop-down menu to select the category which most closely describes the issue you want to report. The menu provides the following options:

   • Bug Report

   • Feature Request

   • Performance Issue

3. In the second drop-down menu, select An extension.

4. The third drop-down menu allows you to specify one of the extensions you have installed. You can type a few characters to find the right entry. For example, isls quickly identifies InterSystems Language Server.

   Which extension should you choose? Here is a guide:

   • Select InterSystems Language Server for issues related to:

     • code coloring

     • Intellisense

   • Select InterSystems ObjectScript for issues related to:

     • export, import and compile

     • ObjectScript Explorer (browsing namespace contents)

     • direct server-side editing using isfs:// folders in a workspace

     • integration with server-side source control etc

   • Select InterSystems Server Manager for issues related to:

     • InterSystems Server view

     • password management in local keychain

     • definition and selection of entries in intersystems.servers

   If unsure, select InterSystems ObjectScript.

5. Enter a descriptive one-line summary of your issue. Based on the content of your summary, the dialog suggests a list of existing issues which may be duplicates of your issue. If you don’t find an existing issue that covers yours, proceed.

6. Enter details regarding your issue. If VS Code is authenticated to GitHub, the dialog’s button is labelled Create on GitHub; selecting this button will open the issue on Github and then load it in your browser so that you can edit it. If VS Code is not authenticated to GitHub, the dialog’s button reads Preview on GitHub; selecting it launches a browser page where you must complete and submit your report.

   Here are some tips for using the GitHub page:

   • Paste images from your clipboard directly into the report field. For hard-to-describe issues, an animated GIF or a short MP4 provides invaluable help. The Developer: Toggle Screencast Mode feature within VS Code can help you create a recording.

   • Link to related issues by prefixing the target number with the # character.

   • Remember that whatever you post here is visible to anyone on the Internet. Mask or remove any confidential information. Be polite.