Skip to content

Commit

Permalink
add CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
Trevor committed Dec 8, 2018
1 parent 2c8a978 commit 6eb4bb8
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,21 @@
# Contributing

Before contributing to this repository make sure to discuss first the intended changes either by creating a new issue or commenting an existing one.

## Useful commands

Once the repository has been cloned you can run the following commands from the root directory.

```sh
$ yarn install # install project dependencies
$ yarn lint # run linting against project code
$ yarn test # run test
```

## Submitting code

Any code change should be submitted as a pull request. The description should explain what the code does and give steps to execute it. The pull request should also contain tests.

## Review process

The bigger the pull request, the longer it will take to review and merge. Try to break down large pull requests in smaller chunks that are easier to review and merge. Also make sure to reference the related issues in the pull request message if any.

0 comments on commit 6eb4bb8

Please sign in to comment.