CONTRIBUTING.md

Contributing

This repository and extension are open source in part to encourage contributions. This document exists primarily to let others know how to investigate possible bugs.

Getting Started

1. Clone this repository

2. Open the repository in VS Code

3. Go to Run > Start Debugging to open a separate debugging window

4. Create a file with one of the supported file extensions

5. Type/copy-paste something in the file to test

6. Enable scope inspector

   • Through menu options: View > Command Palette > Developer: Inspect Editor Tokens and Scopes

   • Through keybinding:

     {
       "key": "cmd+alt+shift+i",
       "command": "editor.action.inspectTMScopes"
     }

7. Once enabled click text to see how it's being tagged/scoped

Publishing

Prerequisite: vsce

1. Increment version in the package.json file based on SemVar spec
2. Add version updates to CHANGELOG.md
3. Commit changes as "Prepare release of x.y.z"
4. Cut the tag: git tag x.y.z
5. Push the tag: git push origin x.y.z
6. Package the extension: vsce package
7. Publish the extension: vsce publish
8. Create the release on GitHub based on the tag, uploading the new package

Documentation

• Visual Studio Code | Syntax Highlight Guide