diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..464d41e --- /dev/null +++ b/CONTRIBUTING.md @@ -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. +