From 25df89efc4f4e3dc5a461488d30d2f7d1cd0c28a Mon Sep 17 00:00:00 2001 From: Kevin Qi Date: Sun, 21 Apr 2019 12:32:32 -0700 Subject: [PATCH] tweak CONTRIBUTING with new demo setup --- CONTRIBUTING.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 14f41bc..05b563d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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`.