Skip to content

Latest commit

 

History

History
52 lines (37 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

52 lines (37 loc) · 1.61 KB

Contributing to ITK/VTK ImageViewer

This page documents at a very high level how to contribute to itk-vtk-image-viewer.

  1. The itk-vtk-image-viewer source is maintained on Github at github.com/kitware/itk-vtk-image-viewer

  2. Fork the repository into your user's namespace on Github.

  3. Create a local clone of the main repository:

    $ git clone https://github.com/kitware/itk-vtk-image-viewer.git
    $ cd itk-vtk-image-viewer

    The main repository will be configured as your origin remote.

  4. Run the setup script to prepare itk-vtk-image-viewer:

    $ npm install
    $ npm install -g commitizen
  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

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