Skip to content

Latest commit

 

History

History
67 lines (46 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

67 lines (46 loc) · 2.32 KB
Raw

Contributing to VTK-JS

This page documents at a very high level how to contribute to VTK-JS. Please check our developer instructions for a more detailed guide to developing and contributing to the project, and our [VTK-JS Git README] for additional information.

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

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

  3. Follow the download instructions to create a local clone of the main VTK repository:

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

    The main repository will be configured as your origin remote.

    For more information see: Setup

  4. Run the developer setup script to prepare your VTK-JS work tree:

    $ npm install

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

    $ edit file1 file2 file3
$ git add file1 file2 file3
$ git cz

    For more information see: Create a Topic

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

    $ git push

    For more information see: Share a Topic

  7. Visit your fork in Github, browse to the "Merge Requests" link on the left, and use the "New Merge Request" button in the upper right to create a Merge Request.

    For more information see: Create a Merge Request

VTK 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 API. We have several Mailing Lists to coordinate development and to provide support.