Skip to content

Latest commit

 

History

History
84 lines (59 loc) · 2.37 KB

CONTRIBUTING.md

File metadata and controls

84 lines (59 loc) · 2.37 KB
Raw

Contributing to react-vtk-js

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

Before You Start

Please follow the coding style:

Workflow

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

  2. Fork react-vtk-js into your user's namespace on GitHub.

  3. Clone the repository to your computer.

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

  4. Configure the upstream remote and update the local master branch

    $ git remote add https://github.com/kitware/react-vtk-js.git
$ git fetch upstream --prune --tags
$ git checkout master
$ git pull upstream master

  5. Run the install script for react-vtk-js dependencies:

    $ npm install

  6. Create a feature branch.

    $ git checkout -b new_feature

  7. Start hacking.

    $ edit file1 file2 file3
$ git add file1 file2 file3

  8. Use Commitizen to create commits

    $ npm run commit

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

    $ git push origin new_feature

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

  11. react-vtk-js uses GitHub for code review and Github Actions to validate proposed patches before they are merged.

Notice

  • Don't modify the version number in package.json. It will be automatically updated after the PR is merged.

Reporting Issues

If you encounter problems using react-vtk-js you may be able to find the solutions in the vtk-js troubleshooting docs, in an existing GitHub issue, or via the VTK discourse page. If you can't find the answer, please report a new issue on GitHub.