Skip to content

Latest commit

 

History

History
29 lines (18 loc) · 910 Bytes

CONTRIBUTING.md

File metadata and controls

29 lines (18 loc) · 910 Bytes

Setting up dev environment

fork or clone the repo

$ git clone <git url>
$ cd react-stockcharts
$ npm install
$ npm run watch

open http://localhost:8080 in a browser

Updating documentation

To update the documentation or add an example, update the files under docs.

Most of documentation is written as markdown under the docs/md folder

see the docs/documentation.js file to understand how the different pages are organized

docs/lib/charts folder contains the different charts in the examples, the same are used to build the gists in quick start examples also

Updating source

To update the source update files under src

Help needed

Look for issues with the enhancement, help_wanted