Contributing

We welcome your contributions to the development of ParaView Visualizer. 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/visualizer.

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

   $ git clone https://github.com/<username>/visualizer.git
   $ cd visualizer
   $ npm install
   $ npm install -g commitizen

3. Create a feature branch.

   $ git checkout -b new_feature

4. Start hacking.

5. Use Commitizen for commit message

   $ git cz

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 Visualizer documentation is part of the code repository.

Reporting Issues

When you encounter some problems when using ParaView Visualizer, you can find the solutions in Troubleshooting or ask me on GitHub or Mailing list. If you can’t find the answer, please report it on GitHub.