Skip to content
Roberto Huertas edited this page Apr 30, 2022 · 3 revisions

How to submit an Issue

IMPORTANT: For folder icon requests please first see our supported folder list.

  • Do a search before opening a new issue. If it exists, add a comment to it instead of opening a new one.

  • Screenshots are more than welcome!

In order to submit a useful issue, we would highly appreciate if you fill the provided template according to the following instructions:

  • Use [Icon Request] Support for ::place the name here:: as title if you want to submit an icon request, otherwise use a meaningful title.

  • Keep the proposed markdown format, where it exists, for the filled in info (i.e. ``).

  • Put an 'x' between the brackets. Make sure to remove any excess spaces.

i.e. - [x] I'm sure this issue is not a duplicate.

  • If you are not requesting an icon, remove all the lines following the "not duplicate" statement.

  • If you are requesting an icon, make sure to fill in these mandatory info:

    • Type: <- use one or more of the following: extension, filename, languageId (see APPENDIX section)
    • Icon Name: <- suggest an icon name, usually this is the tool or language name
    • Sample original Icon: <- provide a link to the icon, preferable a 32x32, svg, transparent icon if possible, by placing the url inside the parenthesis
    • More info: <- provide a link to the site or any documentation, on where we could get more info about your request.
  • Fill in the following info according to the info you provided in Type, and remove the lines not used (see APPENDIX section).

    • Extensions: <- REMOVE if Type does not include extension else provide comma separated list of file extensions.
    • Filenames: <- REMOVE if Type does not include filename else provide comma separated list of filenames.
    • Language ids: <- REMOVE if Type does not include language id else provide comma separated language ids.
    • Language Extensions: <- if Type includes languageId, provide links to the vscode extensions, found in the marketplace, that support language highlighting, otherwise remove the entire line.

APPENDIX

Possible values for Type are:

  • extension, when the request refers to file extension/s (i.e. .txt).
  • filename, when the request refers to filename/s (i.e. filename.txt).
  • language id, when the request refers to a, vscode or a 3rd party extension, language id (if you are not sure use any of the above).

There are cases where an icon can be supported via more than one way. For example an icon could show up using a 'language id' but the extension registering it doesn't support a certain file extension or filename.

In that case Type can be set as:

Type: extension, language id

or

Type: filename, language id

or even

Type: extension, filename, language id

and thus the explanatory section should be like:

  • Extensions: txt, conf, ini (if Type has extension)
  • Filenames: somefilename.txt, somefilename.conf.js (if Type has filename)
  • Language ids: ruby, elixir, elm (if Type has language id)