CONTRIBUTING.md

Contributing

Pull requests are welcome. You must follow the coding style of the existing files (based on prettier), and include unit tests and documentation. Be prepared for a thorough code review, and be patient for the merge - this is an open-source initiative.

You can run the tests (linting, unit and functional tests) by calling

make test

or

yarn test

If you have coding standards problems, you can fix them automatically using prettier by calling

make prettier

or

yarn prettier

If you are using toggle as a dependency, and if you want to try and hack it, here is the advised process:

# in myapp
# install toggle from GitHub in another directory
$ cd ..
$ git clone git@github.com:MathieuDoyon/toggle.git && cd toggle && make install
# replace your node_modules/toggle by a symbolic link to the github checkout
$ cd ../myapp
$ npm link ../toggle/packages/toggle
# go back to the checkout, and replace the version of react by the one in your app
$ cd ../toggle
$ npm link ../myapp/node_modules/react
$ make watch
# in another terminal, go back to your app, and start it as usual
$ cd ../myapp
$ npm run

for more information see Toggle development

Tip: If you're on Windows and can't use make, try this Gist.