We welcome your contribution to the development of ParaViewWeb. This document will help you through the process.
Please follow the coding style:
- Follow the Airbnb JavaScript Style Guide.
- Use spaces, not tabs, with a two space indent.
- Don't put commas first.
- Fork kitware/paraviewweb.
- Clone the repository to your computer and install dependencies.
$ git clone https://github.com/<username>/paraviewweb.git
$ cd paraviewweb
$ npm install
$ npm install -g commitizen- Create a feature branch.
$ git checkout -b new_feature- Start hacking.
- Test examples.
$ npm run doc:www- Use Commitizen for your commit message.
$ git cz- Push the branch.
$ git push --set-upstream origin new_feature- Create a pull request and describe the change.
- Don't modify version number in
package.json. It is changed automatically. - Your pull request can only be merged when the tests have passed. Don't forget to run tests before submission.
$ npm testTesting changes to UI components is done by running the documentation and examples locally and viewing the results. To do that, run the following:
$ npm run doc:wwwThen open a web browser to http://localhost:4000/paraviewweb to view the documentation and examples based on the locally modified ParaViewWeb.
The ParaViewWeb documentation is part of the code repository.
If you encounter problems when using ParaViewWeb, you can look for the solutions in Troubleshooting or our Mailing list. If you can't find the answer, please report an issue on GitHub. Thanks!