Skip to content

Commit 440a476

Browse files
swap to yargs for consistency with our other projects
1 parent 99f4b72 commit 440a476

File tree

4 files changed

+2677
-3998
lines changed

4 files changed

+2677
-3998
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,24 @@
11
# Contributing
2-
Anyone should feel free to fork/PR this. Open source for the win!
3-
Please make sure and explain your changes thoroughly, update version and changelog where needed.
42

5-
_Note_: HubL tags, functions, expression tests and filters are all pulled from the `cos-rendering/v1/hubldoc` api, so do not update any `snippets/auto-gen/...` json files manually. Run `npm run generate` to re-generate these JSON files when HubL changes occur. `snippets/man_gen/...` files are for any extra/helpful snippets used in HubL - these files are maintained manually.
3+
Anyone should feel free to fork/PR this. Open source for the win! Please make sure and explain your changes thoroughly, update version and changelog where needed.
4+
5+
_Note_: HubL tags, functions, expression tests and filters are all pulled from the `cos-rendering/v1/hubldoc` api, so do not update any `snippets/auto-gen/...` json files manually. Run `yarn generate` to re-generate these JSON files when HubL changes occur. `snippets/man_gen/...` files are for any extra/helpful snippets used in HubL - these files are maintained manually.
66

77
### To run this extension locally:
8+
89
- `git clone` repo
9-
- Compile the extension with `npm run dev`
10+
- Install dependencies with `yarn install`
11+
- Compile the extension with `yarn dev`
1012
- Open this project in Visual Studio Code
1113
- Press `f5` to launch a new VSCode window with the extension installed
1214
- Press `CMD` + `R` to reload the window after having made any changes
1315

1416
### Debugging
17+
1518
Debugging grammar scopes can be done line-by-line using the [VSCode scope inspector](https://code.visualstudio.com/api/language-extensions/syntax-highlight-guide#scope-inspector).
1619

1720
### Publishing
21+
1822
_Note: In order to publish you'll need to be added as a user in the HubSpot Azure Devops organization_
1923

2024
- Install the [vsce](https://github.com/microsoft/vscode-vsce) command line tool
@@ -24,6 +28,8 @@ _Note: In order to publish you'll need to be added as a user in the HubSpot Azur
2428
- Run `vsce publish minor`, which will increment the version number in `package.json` and publish the extension to the VS Code Marketplace
2529

2630
### VSCode Extension Links
31+
2732
Configuration
28-
- [Contribution points](https://code.visualstudio.com/api/references/contribution-points)
29-
- [Activation events](https://code.visualstudio.com/api/references/activation-events)
33+
34+
- [Contribution points](https://code.visualstudio.com/api/references/contribution-points)
35+
- [Activation events](https://code.visualstudio.com/api/references/activation-events)

0 commit comments

Comments
 (0)