Skip to content

Commit 50cf171

Browse files
committed
updated docs
1 parent 104d319 commit 50cf171

1 file changed

Lines changed: 23 additions & 8 deletions

File tree

CONTRIBUTING.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,37 @@
22

33
## License Agreement
44

5-
When providing any contributions, you must agree and be legally entitled to provide them for use and distribution in the project under the same terms as the [license](https://github.com/liabru/matter-js/blob/master/LICENSE), otherwise they can not be accepted.
5+
By providing any kind of contribution to this project, **you must agree and be legally entitled** to provide them for use and distribution as a part of this project **wholly under the same terms as in the original included [license](https://github.com/liabru/matter-js/blob/master/LICENSE)**.
6+
7+
## Contributions
8+
9+
Contributions by pull request or issues are welcome. Please ensure they follow the same style and architecture as the rest of the code. Use `npm run lint` before submitting. Please **do not include** any changes to the files in the `build` directory.
10+
11+
Before contributing please read the license agreement described at the beginning of this document.
612

713
## Building
814

9-
To build you must first install [node.js](http://nodejs.org/) and [gulp](http://gulpjs.com/), then run
15+
To build you must first install [node.js](http://nodejs.org), then run
1016

1117
npm install
1218

13-
This will install the required build dependencies, then run
19+
which will install the required build dependencies, then run
1420

15-
gulp dev
21+
npm run dev
1622

17-
which is a task that builds the `matter-dev.js` file, spawns a development server and opens `http://localhost:8000/demo/index.html` in your browser. Any changes you make to the source will automatically rebuild `matter-dev.js` and reload your browser.
23+
which will run the development server and opens `http://localhost:8000/demo/index.html` in your browser. Any changes you make to the source will automatically rebuild and reload the page.
1824

19-
## Contributions
25+
## Commands
2026

21-
Contributions by pull request are welcome! Please ensure they follow the same style and architecture as the rest of the code. You should run `gulp test` and ensure there are no reported errors. Please do not include any changes to the files in the `build` directory. All contributors must agree to the license agreement described at the beginning of this document.
27+
The following development commands can be run at the terminal
2228

23-
If you'd like to contribute but not sure what to work on, feel free to get in touch.
29+
- **npm run dev**
30+
runs development server
31+
- **npm run build**
32+
creates a release build
33+
- **npm run lint**
34+
runs the linter
35+
- **npm run test**
36+
runs the tests
37+
- **npm run doc**
38+
builds the documentation

0 commit comments

Comments
 (0)