Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
liorheber authored Mar 23, 2018
1 parent 4ee3e56 commit 034e5af
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## How to Contribute

#### Setting up development environment

1. Fork the repository and create your branch from master.
2. To install the project: `yarn install`
3. Running tests: `yarn test` or `yarn test:watch`
4. Running dev environment to work on `yarn storybook` and head to [https://localhost:6006](https://localhost:6006)


#### Issuing a change

1. Push to github.
2. If you’ve fixed a bug or added code that should be tested, add tests.
3. Open a Pull Request with the following guidelines:
- Set title prefix to feature/bug and supply a descriptive PR title.
- Add description to your Pull Request describing your change.
4. Once your Pull Request is issued the test suite and build processes will run and we will review your change.

0 comments on commit 034e5af

Please sign in to comment.