Skip to content

How to file an issue

Martin van der Schelling edited this page Jan 16, 2023 · 1 revision

GitHub issues will be the main source of communicating bugs and remarks on the f3dasm framework. More information on how that works with GitHub can be found here.

For further improvements, ideas or discussion, please use the GitHub Discussion tab.

How to create an issue

Issues can be created in the following ways:

  1. By going to the 'Issues' tab on the GitHub repository
  2. Creating an issue in your VS code editor

Creating an issues on GitHub

You can create an Issue by going to the ''Issues' tab on the GitHub repository. Please choose one of the categories to label your issue and fill in the form completely.

VS code GitHub extension for issues

It is possible to create an issue directly from the VSCode editor:

  1. Go to 'Extensions' and search for 'GitHub Pull Requests and Issues'
  2. Install the plugin and link your GitHub profile with VSCode
  3. Press Ctrl+P to open the Command Pallete
  4. Type in > create issue. The first suggestion will be 'GitHub Issues: Create Issue From Selection' !
  5. Click on the gear icon on the right !
  6. Double-click on Keybinding
  7. Choose a suitable keybinding for this action. I chose Ctrl+K I
  8. Done!

Now, whenever you select a line of code and want to create an issue for it, you will hit the appropriate keybind and you will make an issue!