Skip to content

Commit d0dff21

Browse files
committed
contributing document
1 parent ef4f2f1 commit d0dff21

File tree

2 files changed

+60
-0
lines changed

2 files changed

+60
-0
lines changed

.vscode/extensions.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"recommendations": [
3+
"esbenp.prettier-vscode",
4+
"dbaeumer.vscode-eslint",
5+
"EditorConfig.EditorConfig"
6+
]
7+
}

CONTIBUTING.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Contributing to the ObjectScript extension for Visual Studio Code
2+
3+
## Contributing a pull request
4+
5+
### Prerequisites
6+
7+
1. [Node.js](https://nodejs.org/) 12.x
8+
1. Windows, macOS, or Linux
9+
1. [Visual Studio Code](https://code.visualstudio.com/)
10+
1. The following VS Code extensions:
11+
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
12+
- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
13+
- [EditorConfig for VS Code](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)
14+
15+
### Setup
16+
17+
```shell
18+
git clone https://github.com/intersystems-community/vscode-objectscript
19+
cd vscode-objectscript
20+
npm install
21+
```
22+
23+
### Errors and Warnings
24+
25+
TypeScript errors and warnings will be displayed in the `Problems` window of Visual Studio Code.
26+
27+
### Run dev build and validate your changes
28+
29+
To test changes, open the `vscode-objectscript` folder in VSCode.
30+
Then, open the debug panel by clicking the `Run and Debug` icon on the sidebar, select the `Launch Extension` or `Launch Extension Alone`
31+
option from the top menu, and click start. A new window will launch with the title
32+
`[Extension Development Host]`.
33+
34+
### Pull requests
35+
36+
We do expect CI to be passing for a pull request before we will consider merging it. CI executed by Pull requests will produce `vsix` file, which can be downloaded and installed manually to test proposed functionality.
37+
38+
## Beta versions
39+
40+
Any change to `master` branch will call CI, which will produce [beta release](https://github.com/intersystems-community/vscode-objectscript/releases), which can be manually installed.
41+
42+
## Local Build
43+
44+
Steps to build the extension on your machine once you've cloned the repo:
45+
46+
```bash
47+
> npm install -g vsce
48+
# Perform the next steps in the vscode-objectscript folder.
49+
> npm install
50+
> npm run package
51+
```
52+
53+
Resulting in a `vscode-objectscript-$VERSION.vsix` file in your `vscode-objectscript` folder.

0 commit comments

Comments
 (0)