We welcome you to join the development of ParaView ArcticViewer. This document will help you through the process.

Before You Start

Please follow the coding style:


  1. Fork kitware/arctic-viewer into your own Github account.
  2. Clone the forked repository to your computer and install dependencies.

    $ git clone<username>/arctic-viewer.git
    $ cd arctic-viewer
    $ 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 add <newfiles>
    $ git cz
  6. Push the branch:

    $ git push origin new_feature
  7. Create a pull request and describe the change.

Updating Documentation

The ParaView ArcticViewer documentation is part of the code repository.

Reporting Issues

When you encounter some problems when using ParaView ArcticViewer, you may be able to find a solution in Troubleshooting or ask a question on our issues list or mailing list. If you can’t find the answer, please report the issue on GitHub.