tweak CONTRIBUTING with new demo setup

This commit is contained in:
Kevin Qi 2019-04-21 12:32:32 -07:00
parent ce3904b722
commit 25df89efc4

View File

@ -1,10 +1,10 @@
# Contributing
## Contributing
To run demo locally on localhost:8080:
Thanks for your interest in helping out! If you'd like to make a change to react-circular-progressbar master, it's preferable to first validate your change by writing what you plan to do in a new [Github issue](https://github.com/kevinsqi/react-circular-progressbar/issues).
```bash
yarn install
yarn start
```
To make your own changes:
Keep tests passing by running `yarn test` and `yarn run lint`.
1. Fork the repo.
2. Go to `/demo` and view the README to see how to run the demo.
3. Make changes to `/src` and they'll be applied immediately to the running demo. You can use this to prototype, but you probably don't need to commit the changes to `/demo` when creating a PR.
4. Add tests for your new changes and make sure they're passing with `yarn test`.