CONTRIBUTING.md 2.46 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
Contributing to ParaView Guide - Community Edition
==================================================

Contritbutions are always welcome. There are several ways of contributing.

1.  You can may your contributions through **[merge requests][]** made to this [GitLab][]
repository.

2.  You can also post your edits to the [Mailing List][], coordinating with any of
the ParaView developers to get your updates in.

3.  Alternatively, you can also post your text changes directly on a new issue on the
[issue tracker] or in a [snippet].

For those interested in making changes through the **[merge requests][]**, the workflow
is as follows:

1.  Register with [GitLab Access] to create an account and select a user name.

2.  [Fork ParaViewGuide-CE][] into your user's namespace on GitLab.

3.  Clone the repository:

24 25 26
        $ mkdir ParaViewGuide; cd ParaViewGuide
        $ git clone https://gitlab.kitware.com/paraview/paraview-guide-ce.git src
        $ cd src
27 28 29 30 31 32
    The main repository will be configured as your `origin` remote.
    
4.  Add your fork as a the `gitlab` remote.

        $ git remote add gitlab https://gitlab.kitware.com/username/paraview-guide-ce.git
    You can use configure the remote to use SSH access instead, if needed.
33

Aron Helser's avatar
Aron Helser committed
34
5.  Install dependencies and [build](build.md)
35

36 37 38 39
        $ mkdir ../build; cd ../build
        $ ccmake ../src
        $ make

40
6.  Edit files and create commits (repeat as needed):
41 42 43 44 45 46

        $ git checkout -b my-topic origin/master
        $ edit file1 file2 file3
        $ git add file1 file2 file3
        $ git commit
        
47
7.  Push commits in your topic branch to your fork in GitLab:
48 49 50

        $ git push gitlab HEAD
        
51
8.  Visit your fork in GitLab, browse to the "**Merge Requests**" link on the
52 53 54 55 56 57 58 59 60 61 62 63 64 65
    left, and use the "**New Merge Request**" button in the upper right to
    create a Merge Request.

Please refer to [ContributorNotes.tex][] to guidelines on contributing content
for the guide.

[merge requests]: https://gitlab.kitware.com/paraview/paraview-guide-ce/merge_requests
[GitLab]: https://gitlab.kitware.com/paraview/paraview-guide-ce/
[Mailing List]: http://www.paraview.org/mailing-lists/
[ContributorNotes.tex]: ParaView/ContributorNotes.tex
[GitLab Access]: https://gitlab.kitware.com/users/sign_in
[Fork ParaViewGuide-CE]: https://gitlab.kitware.com/paraview/paraview-guide-ce/fork/new
[issue tracker]: https://gitlab.kitware.com/paraview/paraview-guide-ce/issues
[snippet]: https://gitlab.kitware.com/paraview/paraview-guide-ce/snippets