Skip to content

Latest commit

 

History

History
115 lines (81 loc) · 4.89 KB

File metadata and controls

115 lines (81 loc) · 4.89 KB

Contributing

Thank you for contributing. Contributions are always welcome, no matter how large or small.

Table of Contents


Guidelines

As a contributor, here are the guidelines you should follow:

We also recommend to read How to Contribute to Open Source.


Pull Requests

Thank you for contributing.


Clone the Repository

git clone git@github.com:seantrane/balanced-theme-for-vscode.git balanced-theme-for-vscode && cd balanced-theme-for-vscode

Install Dependencies

# Using NPM:
npm install

VS Code Extension Quickstart

What's in the folder

  • This folder contains all of the files necessary for your extension
  • package.json - this is the manifest file that defines the location of the theme file and specifies the base theme of the theme
  • themes/BalanceD.tmTheme - the color theme definition file

Get up and running straight away

  • press F5 to open a new window with your extension loaded
  • open File > Preferences > Color Themes and pick your color theme

Make changes

  • you can relaunch the extension from the debug toolbar after making changes to the files listed above
  • you can also reload (Ctrl+R or Cmd+R on Mac) the VS Code window with your extension to load your changes

Install your extension

  • To start using your extension with Visual Studio Code copy it into the <user home>/.vscode/extensions folder and restart Code.
  • To share your extension with the world, read on https://code.visualstudio.com/docs about publishing an extension.

VS Quick Links


File Structure

balanced-theme-for-vscode/
 ├─ themes/                    * the directory containing color theme definition file(s)
 │   ├─ BalanceD.tmTheme       * BalanceD Syntax Theme definition file
 │   :
 │
 ├─ .markdownlint.yaml         * markdown lint rules and config
 ├─ CONTRIBUTING.md            * contribution guidelines
 ├─ CHANGLOG.md                * changelog autogenerated by `@semantic-release/changelog`
 ├─ package-lock.json          * npm package dependency lock file
 ├─ package.json               * npm package config
 └─ ROADMAP.md                 * package roadmap

Happy coding!