mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-10-05 01:49:02 +00:00
Update file CONTRIBUTING.md
This commit is contained in:
parent
fc90853673
commit
6df195ed0d
@ -19,7 +19,7 @@ Before you begin, perform initial setup:
|
||||
|
||||
3. Use Git to create a local clone of the main VTK repository:
|
||||
|
||||
$ git clone https://gitlab.kitware.com/vtk/vtk-m.git
|
||||
$ git clone git@gitlab.kitware.com:vtk/vtk-m.git
|
||||
$ cd vtk-m
|
||||
|
||||
The main repository will be configured as your `origin` remote.
|
||||
@ -32,19 +32,24 @@ Before you begin, perform initial setup:
|
||||
This will prompt for your GitLab user name and configure a remote
|
||||
called `gitlab` to refer to it.
|
||||
|
||||
5. (Optional but highly recommended.)
|
||||
5. (Required to use Git LFS.)
|
||||
[Using the SSH URL for the origin remote] is needed to for Git LFS to work.
|
||||
Do not forget to run `$ ./Utilities/SetupForDevelopment.sh` after changing
|
||||
the remote URL.
|
||||
|
||||
6. (Optional but highly recommended.)
|
||||
[Disabling git-lfs in your fork] is needed to add/modify git-lfs files.
|
||||
Find the setting to disable git-lfs in your fork through your fork web UI:
|
||||
Settings/General/Project Features/Git LFS; set it to off; and _save changes_.
|
||||
|
||||
6. (Optional but highly recommended.)
|
||||
7. (Optional but highly recommended.)
|
||||
[Register with the VTK-m dashboard] on Kitware's CDash instance to
|
||||
better know how your code performs in regression tests. After
|
||||
registering and signing in, click on "All Dashboards" link in the upper
|
||||
left corner, scroll down and click "Subscribe to this project" on the
|
||||
right of VTK-m.
|
||||
|
||||
7. (Optional but highly recommended.)
|
||||
8. (Optional but highly recommended.)
|
||||
[Sign up for the VTK-m mailing list] to communicate with other
|
||||
developers and users.
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user