vscode/extensions/theme-seti/CONTRIBUTING.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

34 lines
1.8 KiB
Markdown
Raw Normal View History

2021-03-01 16:11:36 +00:00
# theme-seti
This is an icon theme that uses the icons from [`seti-ui`](https://github.com/jesseweed/seti-ui).
2021-05-11 15:58:22 +00:00
## Previewing icons
There is a [`./icons/preview.html`](./icons/preview.html) file that can be opened to see all of the icons included in the theme.
To view this, it needs to be hosted by a web server. The easiest way is to open the file with the `Open with Live Server` command from the [Live Server extension](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer).
2021-03-01 16:11:36 +00:00
2021-05-11 15:58:22 +00:00
## Updating icons
2021-03-01 16:11:36 +00:00
2021-05-11 15:58:22 +00:00
- Make a PR against https://github.com/jesseweed/seti-ui` with your icon changes.
- Once accepted there, ping us or make a PR yourself that updates the theme and font here
2021-03-01 16:11:36 +00:00
2021-05-11 15:58:22 +00:00
To adopt the latest changes from https://github.com/jesseweed/seti-ui:
2021-03-01 16:11:36 +00:00
2021-05-11 15:58:22 +00:00
- have the main branches of `https://github.com/jesseweed/seti-ui` and `https://github.com/microsoft/vscode` cloned in the same parent folder
- in the `seti-ui` folder, run `npm install` and `npm run prepublishOnly`. This will generate updated icons and fonts.
- in the `vscode/extensions/theme-seti` folder run `npm run update`. This will launch the [icon theme update script](build/update-icon-theme.js) that updates the theme as well as the font based on content in `seti-ui`.
- to test the icon theme, look at the icon preview as described above.
- when done, create a PR with the changes in https://github.com/microsoft/vscode.
Add a screenshot of the preview page to accompany it.
2021-03-01 16:11:36 +00:00
### Languages not shipped with `vscode`
Languages that are not shipped with `vscode` must be added to the `nonBuiltInLanguages` object inside of `update-icon-theme.js`.
These should match [the file mapping in `seti-ui`](https://github.com/jesseweed/seti-ui/blob/master/styles/components/icons/mapping.less).
Please try and keep this list in alphabetical order! Thank you.