vsc-material-theme/CONTRIBUTING.md

Contributing guidelines

Note: this document is intended as a draft, it will be updated soon

Requirements:

• Nodejs ^6.x
• Visual Studio Code
• GPG Tool

• Contributing guidelines
  • Requirements:
  • Decrypt content
  • Installing and compiling source
    • Testing the theme
    • Adding new Material Theme commands
    • Adding new icons
  • Financial contributions
  • Credits
    • Contributors
    • Backers
    • Sponsors

Decrypt content

We use git-crypt to encrypt compiler files. To contribute you need a GPG key public/private associated with your github email.

1. Export your public key by running

gpg --output PATH/FILENAME.gpg --export ASSOCIATEDEMAIL

2. Send the exported .gpg file to a contributor that will add you to the trusted people.
3. Fetch and pull then decrypt files with git-crypt unlock entering your key password.

Installing and compiling source

First you will have to install node_modules through npm or yarn

npm install
# or
yarn install

To compile to the source code, you have to execute the build task through visual studio code. First you need to invoke to quick command (on MacOS ⌘P, while on Linux/windows is ctrl+p) then type task build and wait until vsc will have finished the task.

Testing the theme

To test the theme, you will have to go to the debug section, select the Launch Extension from debug and execute it.

Adding new Material Theme commands

Soon(ish)®

Adding new icons

• Add your icon to the ~/src/icons/svgs directory.

• Add the reference to that icon to the ~/src/icons/partials/fileNames.js or if your icon is referred to a directory adds the reference to the ~/src/icons/partials/folderNames.js file, otherwise to ~/src/icons/partials/fileExtensions.js if is referred to a file extension.

• If you want to make the icon sensitive to be accented, modify the ~/extensions/defaults.json file, adding the icon definition to the accentableIcons array (e.g. ["_folder_open", "_folder_open_build"]) and the path to the icons.theme.iconDefinitions object. The same applies to variants (the variant icons array is called "variantsIcons")

• Execute the build command.

• Enjoy your new icons in Material Theme, and don't forget to pull request!

Financial contributions

We also welcome financial contributions in full transparency on our open collective. Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed.

Credits

Contributors

Thank you to all the people who have already contributed to vsc-material-theme!

Backers

Thank you to all our backers! [Become a backer]

Sponsors

Thank you to all our sponsors! (please ask your company to also support this open source project by becoming a sponsor)