Commit 93a60627 authored by Robert Maynard's avatar Robert Maynard

CONTRIBUTING: Add an overview of the development process

The actual documentation for contributing to VTK is buried inside
the fourth link when browsing the VTK project. This adds a stripped down
version of how to contribute to the main CONTRIBUTING, and which links directly
to the subsections of develop.md that document each step of the process.
parent 222cf392
Contributing to VTK
===================
Our project uses GitLab for code review and Buildbot to test proposed
patches before they are merged. Please check our [VTK Git][]
instructions for details on developing and contributing to the project.
This page documents at a very high level how to contribute to VTK.
Please check our [developer instructions][] for a more detailed guide to
developing and contributing to the project.
1. Register [GitLab Access] to create an account and select a user name.
2. [Fork VTK][] into your user's namespace on GitLab.
3. Follow the [download instructions][] to create a
local clone of the main VTK repository:
$ git clone https://gitlab.kitware.com/vtk/vtk.git VTK
$ cd VTK
The main repository will be configured as your `origin` remote.
For more information see: [Setup][]
4. Run the [developer setup script][] to prepare your VTK work tree and
create Git command aliases used below:
$ ./Utilities/SetupForDevelopment.sh
This will prompt for your GitLab user name and configure a remote
called `gitlab` to refer to it.
For more information see: [Setup][]
5. Edit files and create commits (repeat as needed):
$ edit file1 file2 file3
$ git add file1 file2 file3
$ git commit
For more information see: [Create a Topic][]
6. Push commits in your topic branch to your fork in GitLab:
$ git gitlab-push
For more information see: [Share a Topic][]
7. 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.
For more information see: [Create a Merge Request][]
VTK uses GitLab for code review and Buildbot to test proposed
patches before they are merged.
Our [Wiki][] is used to document features, flesh out designs and host other
documentation. Our API is documented using [Doxygen][] with updated
documentation generated nightly. We have several [Mailing Lists][]
to coordinate development and to provide support.
[VTK Git]: Documentation/dev/git/README.md
[developer instructions]: Documentation/dev/git/develop.md
[GitLab Access]: https://gitlab.kitware.com/users/sign_in
[Fork VTK]: https://gitlab.kitware.com/vtk/vtk/fork/new
[download instructions]: Documentation/dev/git/download.md#clone
[developer setup script]: /Utilities/SetupForDevelopment.sh
[Setup]: Documentation/dev/git/develop.md#Setup
[Create a Topic]: Documentation/dev/git/develop.md#create-a-topic
[Share a Topic]: Documentation/dev/git/develop.md#share-a-topic
[Create a Merge Request]: Documentation/dev/git/develop.md#create-a-merge-request
[Wiki]: http://www.vtk.org/Wiki/VTK
[Doxygen]: http://www.vtk.org/doc/nightly/html
[Mailing Lists]: http://www.vtk.org/VTK/help/mailing.html
......@@ -57,6 +57,13 @@ If you have found a bug:
[VTK Issue Tracker]: http://www.vtk.org/Bug
Contributing
============
See [CONTRIBUTING.md][] for instructions to contribute.
[CONTRIBUTING.md]: CONTRIBUTING.md
License
=======
......@@ -64,10 +71,3 @@ VTK is distributed under the OSI-approved BSD 3-clause License.
See [Copyright.txt][] for details.
[Copyright.txt]: Copyright.txt
Contributing
============
See [CONTRIBUTING.md][] for instructions to contribute.
[CONTRIBUTING.md]: CONTRIBUTING.md
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment