Skip to content

Commit 9a7eea1

Browse files
committed
Update CONTRIBUTING.md
1 parent 597a592 commit 9a7eea1

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

CONTRIBUTING.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,18 @@ Before creating bug reports, please check the [issues](https://github.com/amarof
1313
### How to contribute?
1414

1515
1. Fork this repo to your account then clone it to your environment.
16-
1. Run `npm install` and `npm start` to get things going.
16+
1. Run `npm install` to get things going.
1717
1. Replicate the issue you're trying to fix or spec out the feature you're trying to add. Understanding the scope of what you're fixing or adding is important and upfront thought helps.
1818
1. Change the code to fix the bug or add the feature. All changes should happen in the relevant `*.jsx` and `*.scss` files in the `/src` directory.
19-
1. Verify that your fix or feature works. If it a new feature make to add it to the demo.
19+
1. Verify that your fix or feature works locally.
2020
1. Run `npm run precommit` to lint all the files and run the tests
2121
1. Run `npm run build` to bundle the production files.
22-
1. if you changed the demo you must run `npm run build:demo` before pushing.
2322
1. Commit your changes with an informative description. Do not make a single commit for big updates.
2423
1. Open a pull request to the primary repo with your new commits and a descriptive message about what the PR does.
2524

25+
### Running the code locally
26+
- Download the demo source from [codesandbox](https://codesandbox.io/s/ovvwzkzry9) and install the dependencies
27+
- Link your local repo into the demo source code. Check [npm-link](https://docs.npmjs.com/cli/link.html) for instructions.
2628

2729
### What can I contribute?
2830

0 commit comments

Comments
 (0)