Skip to content

Commit eaddfdd

Browse files
committed
Add CONTRIBUTING.md
1 parent e0320be commit eaddfdd

File tree

2 files changed

+40
-1
lines changed

2 files changed

+40
-1
lines changed

CONTRIBUTING.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Contributing
2+
3+
Thanks for taking the time to contribute! 🙇‍♀️🙇‍♂️ Every little bit of help counts!
4+
5+
## Install
6+
7+
### Requirements:
8+
- [node.js](https://nodejs.org/en/)
9+
- [Visual Studio Code](https://code.visualstudio.com/download)
10+
11+
12+
Clone the repository and enter into the project's folder:
13+
14+
```shell
15+
$ git clone [email protected]:scanapi/vscode-extension.git
16+
$ cd vscode-extension
17+
```
18+
19+
Install the dependencies:
20+
21+
```shell
22+
$ npm install
23+
```
24+
25+
## Run
26+
27+
```shell
28+
$ npm run vscode:prepublish
29+
```
30+
31+
Then, open the vscode-extension folder inside the editor:
32+
33+
```shell
34+
$ code .
35+
```
36+
37+
Select the file `src/extension.ts` and press `F5`. Select the option `VS Code Extension Development (Preview)`.
38+
39+
This will compile and run the extension in a new Extension Development Host window. There you can test the extension running locally.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Check ScanAPI's [documentation](https://github.com/scanapi/scanapi) for futher i
88

99
## Installing
1010

11-
Preferably, install it from the VSCode Marketplace, but if for some reason you can't, you can download the latest stable version [here](https://github.com/scanapi/vscode-extension/releases).
11+
Preferably, install it from the VS Code Marketplace, but if for some reason you can't, you can download the latest stable version [here](https://github.com/scanapi/vscode-extension/releases).
1212

1313
Install it using:
1414

0 commit comments

Comments
 (0)