Skip to content

Commit

Permalink
add contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
williambelle committed May 23, 2019
1 parent c298754 commit c40d8b8
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,46 @@
Contributing
============

Welcome, so you are thinking about contributing ?
Awesome, this a great place to start.

Setup
-----

```bash
git clone git@github.com:innovativeinnovation/epfl-unit-api.git
cd epfl-unit-api
npm i
```

Test
----

Unit and integration tests:

```bash
npm t
```

Code coverage:

```bash
npm run coverage
```

Release
-------

1. Bump the correct version (`npm version [<newversion> | major | minor | patch]`)
2. Update the file [CHANGELOG.md](CHANGELOG.md)
3. Create the tag (`git tag -a v<version> -m "Tagging the v<version> release"`)
4. Publish with `npm publish`

License
-------

Apache License 2.0

(c) William Belle, 2019.

See the [LICENSE](LICENSE) file for more details.

0 comments on commit c40d8b8

Please sign in to comment.