11# Contributing Guide
22Thanks for your interest in improving vscode-vba!
33
4+
45## Creating Issues
56Report bugs or suggest new features.
67
78Before opening a issue, please first search in [ open issues] [ issues ] to check it is not already reported.
89
910In case your issue already exists, add a reaction and if possible, comment with further information.
1011
12+
1113## Creating Pull Requests
1214> Before making bigger changes, please discuss them in an issue.
1315
1416In general PRs should be kept as small as possible (e.g. one feature/fix per PR).
1517It allows merging them faster with less conflicts and will reduce review time.
1618
19+
1720### Repository Setup
1821- Install the Bait programming language: https://github.com/tiabeast/bait#building-from-source
1922- Create and clone a fork of https://github.com/serkonda7/vscode-vba
2023- Run ` npm install ` inside the cloned directory
2124- Create a new working branch for your changes
2225
23- ## Regexes
24- TextMate uses Oniguruma regexes which are mostly compatible with PCRE.
25- A quite decent overview and comparison can be found here: https://rbuckton.github.io/regexp-features/engines/oniguruma.html
2626
27+ ## Regexes and TextMate Scopes (Syntax Highlighting)
28+ TextMate uses Oniguruma regexes which are mostly compatible with PCRE ([ Compariosn] [ oniguruma-overview ] ).
2729A good tool to test these regexes is https://regexr.com/ in PCRE mode.
2830
31+ For a list of predefined scopes see https://macromates.com/manual/en/language_grammars#naming_conventions .
32+
33+
2934### Unit Tests
3035Every PR should contain a test case that covers the added feature or bug fix.
3136This prevents regressions and makes reviewing the changes easier by providing a proof of correct functionality.
@@ -36,6 +41,7 @@ They can be run with the following command:
3641npm run test
3742```
3843
44+
3945### Install a dev version
4046If you'd like to install a development version of the extension, follow these steps:
41471 . ``` sh
@@ -47,5 +53,7 @@ If you'd like to install a development version of the extension, follow these st
4753
4854> Note: It is not required to uninstall any previous versions.
4955
56+
5057<!-- links -->
5158[ issues ] : https://github.com/serkonda7/vscode-vba/issues
59+ [ oniguruma-overview ] : https://rbuckton.github.io/regexp-features/engines/oniguruma.html
0 commit comments