Shuenhoy/vtk-m
1
0
Fork 0
mirror of https://gitlab.kitware.com/vtk/vtk-m synced 2024-10-05 01:49:02 +00:00
Code Issues 2 Actions Packages Projects Releases Wiki Activity

Minor fixes and changes to CONTRIBUTING

Browse Source 
Fixed bad directory name for clone command.

Added suggestion to sign up for mailing list.

Corrected statement about the location of data files.
This commit is contained in:
Kenneth Moreland 2017-09-19 10:22:57 -06:00
parent 2fa3a868bd
commit 1ea16957e2
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
CONTRIBUTING.md
View File

@ -22,7 +22,7 @@ Before you begin, perform initial setup:
3. Follow the [download instructions](download.md#clone) to create a
local clone of the main VTK repository:
$ git clone https://gitlab.kitware.com/vtk/vtk-m.git VTK
$ git clone https://gitlab.kitware.com/vtk/vtk-m.git
$ cd vtk-m
The main repository will be configured as your `origin` remote.
@ -41,6 +41,10 @@ Before you begin, perform initial setup:
"All Dashboards" link in the upper left corner, scroll down and click
"Subscribe to this project" on the right of VTK-m.
6. (Optional but highly recommended.)
[Sign up](http://vtk.org/mailman/listinfo/vtkm) for the VTK-m mailing
list to communicate with other developers and users.
[GitLab Access]: https://gitlab.kitware.com/users/sign_in
[Fork VTK-m]: https://gitlab.kitware.com/vtk/vtk-m/forks/new
@ -100,9 +104,9 @@ A reader should have a general idea of the feature or fix to be developed given
$ git commit
Caveats:
* Data files must be placed in either the root data directory, or a
folder explicitly named 'data'. This is required as VTK-m uses Git-LFS
to efficiently support data files.
* Data files must be placed under a folder explicitly named 'data'.
This is required as VTK-m uses Git-LFS to efficiently support data
files.
Guidelines for Commit Messages