Skip to content

Commit 96efaaf

Browse files
authored
doc: Added contributing.md (#826)
1 parent 032ece8 commit 96efaaf

File tree

3 files changed

+51
-1
lines changed

3 files changed

+51
-1
lines changed

.vscodeignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,5 @@ test/**
2020
tsconfig.json
2121
tslint.json
2222
vsc-extension-quickstart.md
23-
.dependabot/**
23+
.dependabot/**
24+
images/docs/**

CONTRIBUTING.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Contributing
2+
3+
Before you contribute to this project, please open an issue beforehand to discuss the changes you want to make.
4+
5+
## Development setup
6+
7+
Requirements
8+
* [Git](https://git-scm.com/)
9+
* [NodeJs](https://nodejs.org/) >= 12.4.0
10+
* [yarn](https://classic.yarnpkg.com/lang/en/) >= 1.22
11+
12+
First you will need to fork the project
13+
![Github Fork](images/docs/fork.png)
14+
15+
Then clone your fork
16+
```
17+
git clone https://github.com/<YOUR_USERNAME>/svn-scm.git
18+
```
19+
20+
### Dependencies
21+
To install all of the required dependencies run
22+
```
23+
yarn --frozen-lockfile
24+
```
25+
26+
### Build
27+
To build the extension
28+
```
29+
yarn run build
30+
```
31+
32+
### Watch
33+
For development run in watch mode
34+
```
35+
yarn run compile
36+
```
37+
38+
### Formatting
39+
This project uses [prettier](https://prettier.io/) for code formatting. You can run prettier across the code by calling `yarn run style-fix`
40+
41+
### Linting
42+
This project uses [ESLint](https://eslint.org/) for code linting. You can run ESLint across the code by calling `yarn run lint`. To fix fixable errors run `yarn run lint:fix`
43+
44+
### Debugging
45+
Run in VS Code
46+
1. Open the `svn-scm` folder
47+
2. Make sure the [dependencies](#dependencies) are installed
48+
3. Run in [watch](#watch) mode
49+
4. Choose the `Launch Extension` launch configuration from the launch dropdown in the Debug viewlet and press `F5`.

images/docs/fork.png

9.38 KB
Loading

0 commit comments

Comments
 (0)