| 1 | # How to Contribute
|
| 2 | - Before create any pull requests, please open a issue explaining the situation (bug or enhacement)
|
| 3 | - Be sure to follow the eslint rules (webpack will always output its results)
|
| 4 | - Be sure before open the pull request, to test the existent code and/or create tests if you made a new feature.
|
| 5 |
|
| 6 | ## Development Environment (Sandbox Mode)
|
| 7 | **Be sure all the dev-dependencies are installed.**
|
| 8 | Just run the command:
|
| 9 | ```
|
| 10 | npm start
|
| 11 | ```
|
| 12 |
|
| 13 | This will make the webpack compile the dev. env. and set up into a
|
| 14 | webserver with hot deployment into the localhost:8080. There you can make
|
| 15 | changes into the plugin and see in real time all your modifications running.
|
| 16 | Also, every modification will trigger the eslint, so alway check your code style!
|
| 17 |
|
| 18 | You can modify and see live all the modifications changing the file:
|
| 19 | ```
|
| 20 | dev-env/index.js
|
| 21 | ```
|
| 22 | **Be sure not commit this file!**
|
| 23 |
|
| 24 | ## Testing and Building
|
| 25 | After develop/fix a bug, before do a **pull request**, run the test command:
|
| 26 | To run the build, before install the npm and gulp dependencies, then run:
|
| 27 | ```
|
| 28 | npm test
|
| 29 | ```
|
| 30 |
|
| 31 | If you just want to use the latest version directly from the source code just do:
|
| 32 | ```
|
| 33 | npm run build
|
| 34 | ```
|
| 35 | All the files will be outputed in the *dist/* directory |
| \ | No newline at end of file |