Skip to content

Commit

Permalink
📝 Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
elbywan committed Oct 3, 2017
1 parent 1131755 commit c79578a
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions CONTRIBUTING.md
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.

0 comments on commit c79578a

Please sign in to comment.