-
-
Notifications
You must be signed in to change notification settings - Fork 100
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
40 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# Contributing | ||
|
||
Thank you for wishing to collaborate to the wretch library ! | ||
|
||
**Ideas, feedback and help are more than welcome.** | ||
|
||
## How to | ||
|
||
### 1 - Clone the project | ||
|
||
```bash | ||
git clone https://github.com/elbywan/wretch | ||
cd wretch | ||
``` | ||
|
||
### 2 - Install dependencies | ||
|
||
```bash | ||
npm install | ||
``` | ||
|
||
### 3 - Change the code as you see fit | ||
|
||
### 4 - Lint, Build and Test | ||
|
||
```bash | ||
npm start | ||
``` | ||
|
||
The code **must** pass the linter and test checks. | ||
|
||
If you add a new functionality, please write some tests ! | ||
|
||
If a linter rule which is not already set in the tslint.json file is bothering you, feel free to change it. | ||
|
||
### 5 - Commit & Pull request | ||
|
||
If the modification is related to an existing issue, please mention the number in the commit message. (for instance: `closes #10`) | ||
|
||
Always rebase your branch on top of the origin/master branch. |