0
0
Fork 0
mirror of https://github.com/liabru/matter-js.git synced 2024-12-25 13:39:06 -05:00
liabru-matter-js/CONTRIBUTING.md
2016-01-16 20:57:05 +00:00

827 B

Building and Contributing

To build you must first install node.js and gulp, then run

npm install

This will install the required build dependencies, then run

gulp dev

which is a task that builds the matter-dev.js file, spawns a connect and watch server, then opens demo/dev.html in your browser. Any changes you make to the source will automatically rebuild matter-dev.js and reload your browser for quick and easy testing.

Contributions are welcome, please ensure they follow the same style and architecture as the rest of the code. You should run gulp test to ensure eslint gives no errors. Please do not include any changes to the files in the build directory.

If you'd like to contribute but not sure what to work on, feel free to message me. Thanks!