Contributing to VTK-m

This page documents at a very high level how to contribute to VTK-m. Please check our developer instructions for a more detailed guide to developing and contributing to the project.

Register GitLab Access to create an account and select a user name.
Fork VTK-m into your user's namespace on GitLab.
Create a local clone of the main VTK-m repository:
```
$ git clone https://gitlab.kitware.com/vtk/vtk-m.git vtkm
$ cd vtkm
```
The main repository will be configured as your origin remote.
Associate your GitLab fork of VTK-m VTK-m repository:
```
$ git remote add gitlab git@gitlab.com:username/vtk-m.git
```
Your fork will be configured as your gitlab remote.

Edit files and create commits (repeat as needed):

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

Push commits in your topic branch to your fork in GitLab:
```
$ git push gitlab HEAD
```
Visit your fork in GitLab, 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.

VTK-m uses GitLab for code review and Buildbot to test proposed patches before they are merged.

Our Issue Tracker is used to document feature requests and technical issues.

Our Wiki is out to propose new infrastructure designs and host other documentation.

1.7 KiB Raw Blame History

Contributing to VTK-m

1.7 KiB

Raw Blame History