Skip to content

Latest commit

 

History

History
56 lines (39 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

56 lines (39 loc) · 1.72 KB
Raw

Contributing to vtk.js

This page documents at a very high level how to contribute to vtk.js.

  1. The vtk.js source is maintained on Github at github.com/kitware/vtk-js

  2. Fork VTK into your user's namespace on Github.

  3. Create a local clone of the main VTK repository:

    $ git clone https://github.com/kitware/vtk-js.git
$ cd vtk-js

    The main repository will be configured as your origin remote.

  4. Run the setup script to prepare vtk.js:

    $ npm install

  5. Edit files and create commits (repeat as needed):

    $ edit file1 file2 file3
$ git add file1 file2 file3
$ npm run commit

  6. Push commits in your topic branch to your fork in Github:

    $ git push

  7. 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

  8. Additional informations on how to create classe/test/example can be found here in the Development section.

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

Our DevSite is used to document features, flesh out designs and host other documentation as well as the API. There are also several Mailing Lists to coordinate development and to provide support.