Thank you for contributing. Contributions are always welcome, no matter how large or small.
- Guidelines
- Pull Requests
- Clone the Repository
- Install Dependencies
- VS Code Extension Quickstart
- File Structure
As a contributor, here are the guidelines you should follow:
- Code of conduct
- How can I contribute?
- Using the issue tracker
- Submitting a Pull Request
- Coding rules
- Working with code
We also recommend to read How to Contribute to Open Source.
Thank you for contributing.
- Create your branch from
master. - Ensure your git commit messages follow the required format.
- Ensure your scripts are well-formed, well-documented and object-oriented.
- Ensure your scripts are stateless and can be reused by all.
- Update your branch, and resolve any conflicts, before making pull request.
- Fill in the required template.
- Do not include issue numbers in the PR title.
- Include screenshots and animated GIFs in your pull request whenever possible.
- Follow the style guide applicable to the language or task.
- Include thoughtfully-worded, well-structured tests/specs. See the Tests/Specs Style Guide.
- Document new code based on the Documentation Style Guide.
- End all files with a newline.
git clone git@github.com:seantrane/balanced-theme-for-vscode.git balanced-theme-for-vscode && cd balanced-theme-for-vscode# Using NPM:
npm install- 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 themethemes/BalanceD.tmTheme- the color theme definition file
- press
F5to open a new window with your extension loaded - open
File > Preferences > Color Themesand pick your color theme
- you can relaunch the extension from the debug toolbar after making changes to the files listed above
- you can also reload (
Ctrl+RorCmd+Ron Mac) the VS Code window with your extension to load your changes
- To start using your extension with Visual Studio Code copy it into the
<user home>/.vscode/extensionsfolder and restart Code. - To share your extension with the world, read on https://code.visualstudio.com/docs about publishing an extension.
- Developing Extensions
- Publishing Extensions
- Optimizations in Syntax Highlighting
- Semantic release plugin for Visual Stuio Code extensions
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