Skip to content

Latest commit

 

History

History
59 lines (39 loc) · 2.02 KB

CONTRIBUTING.md

File metadata and controls

59 lines (39 loc) · 2.02 KB

Contributing Guide

Thanks for your interest in improving vscode-vba!

Creating Issues

Report bugs or suggest new features.

Before opening a issue, please first search in open issues to check it is not already reported.

In case your issue already exists, add a reaction and if possible, comment with further information.

Creating Pull Requests

Before making bigger changes, please discuss them in an issue.

In general PRs should be kept as small as possible (e.g. one feature/fix per PR). It allows merging them faster with less conflicts and will reduce review time.

Repository Setup

Regexes and TextMate Scopes (Syntax Highlighting)

TextMate uses Oniguruma regexes which are mostly compatible with PCRE (Compariosn). A good tool to test these regexes is https://regexr.com/ in PCRE mode.

For a list of predefined scopes see https://macromates.com/manual/en/language_grammars#naming_conventions.

Unit Tests

Every PR should contain a test case that covers the added feature or bug fix. This prevents regressions and makes reviewing the changes easier by providing a proof of correct functionality.

Tests for the language grammar (syntax highlighting) are in syntaxes/tests. They can be run with the following command:

npm run test

Install a dev version

If you'd like to install a development version of the extension, follow these steps:

  1. npm run install-dev-ext
  2. Reload the VS Code window:
    • Open command palette (F1)
    • Run >reload window

Note: It is not required to uninstall any previous versions.