Contributing

We welcome your contributions to the development of ParaView Lite. This document will help you with the process.

Before You Start

Please follow the coding style:

• Follow Airbnb JavaScript Style Guide.
• Use soft-tabs with a two space indent.
• Don’t put commas first.

Workflow

1. Fork kitware/paraview-lite.

2. Clone the repository to your computer and install dependencies.

   $ git clone https://github.com/<username>/paraview-lite.git
   $ cd paraview-lite
   $ npm install

3. Create a feature branch.

   $ git checkout -b new_feature

4. Start hacking.

5. Use Commitizen for commit message

   $ npm run commit

6. Push the branch:

   $ git push origin new_feature

7. Create a pull request and describe the change.

Notice

• Don’t modify the version number in package.json. It is modified automatically.

• Your pull request will only get merged when tests have passed. Don’t forget to run tests before submission.

  $ npm test

Updating Documentation

The ParaView Lite documentation is part of the code repository.

Reporting Issues

When you encounter a problems with ParaView Lite, please check on GitHub or ParaView Discourse first then ask your question in either communication channel.