Contributing

We welcome you to join the development of vtk.js. This document will help you through the process.

Before You Start

Please follow the coding style:

Workflow

  1. The vtk.js source is maintained on GitHub.

  2. Fork vtk.js into your user’s namespace on GitHub.

  3. Clone the repository to your computer.

    $ git clone https://github.com/<username>/vtk-js.git
    $ cd vtk-js

  4. Run the install script for vtk.js dependencies:

    $ npm install

  5. Create a feature branch.

    $ git checkout -b new_feature

  6. Start hacking. Additional information on how to create class/test/example can be found
    here in the Development section.

    $ edit file1 file2 file3
    $ git add file1 file2 file3

  7. Use Commitizen to create commits

    $ npm run commit

  8. Push commits in your feature branch to your fork in GitHub:

    $ git push origin new_feature

  9. Visit your fork in Github, browse to the “Pull Requests“ link on the left, and use the
    “New Pull Request“ button in the upper right to create a Pull Request.

    For more information see:
    Create a Pull Request

  10. vtk.js uses GitHub for code review and Travis-CI to test proposed patches before they are merged.

Notice

  • Don’t modify the version number in package.json.

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

    $ npm test

Updating Documentation

The vtk.js documentation is part of the code repository and is entirely written in
markdown.

Reporting Issues

If you encounter problems using vtk.js you may be able to find the solutions in the
troubleshooting docs, in an
existing GitHub issue, or via the
mailing list.
If you can’t find the answer, please
report a new issue on GitHub.