Skip to content

Latest commit

 

History

History
54 lines (38 loc) · 1.83 KB

File metadata and controls

54 lines (38 loc) · 1.83 KB

Adding support for a new filetype

Refer to config.cson for instructions on defining a new icon-to-filetype mapping.

Before editing the config, make sure you've installed the devDependencies:

apm install file-icons

You're also encouraged to run package specs, particularly if you've changed existing icons.

NOTE:
Changes to the config require a compilation step. The package does this automatically, but the results won't be visible until the window's been reloaded. Remember to include both config.cson and lib/icons/.icondb.js in your pull request.

If the latter isn't being updated, please file an issue.

Adding new icons to the package

The package's icon-font is handled in its own repository. Consult its readme for instructions on adding new icons.

Updating the changelog

You're encouraged to include your contributions in the project's change-log. Add a line that briefly summarises your additions (preferably 80 characters or less). Preserve the existing format so readers can grep what they're looking for when scanning the file:

New icons:
This should be used for icons that are quite literally new. This may be a custom glyph, or provided by an existing icon file.
Support:
If you're adding support for a new format or filename/extension that uses an existing icon, file it under "Support". That way, there's a clearer distinction between introducing an entirely new icon, and simply extending the scope of an existing one.