-
Notifications
You must be signed in to change notification settings - Fork 84
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
Trevor
committed
Dec 8, 2018
1 parent
2c8a978
commit 6eb4bb8
Showing
1 changed file
with
21 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,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. |