diff options
Diffstat (limited to 'Source/kwsys/CONTRIBUTING.rst')
| -rw-r--r-- | Source/kwsys/CONTRIBUTING.rst | 29 |
1 files changed, 14 insertions, 15 deletions
diff --git a/Source/kwsys/CONTRIBUTING.rst b/Source/kwsys/CONTRIBUTING.rst index 47dffee..d71832a 100644 --- a/Source/kwsys/CONTRIBUTING.rst +++ b/Source/kwsys/CONTRIBUTING.rst @@ -1,28 +1,28 @@ Contributing to KWSys ********************* -Overview -======== +Patches +======= KWSys is kept in its own Git repository and shared by several projects via copies in their source trees. Changes to KWSys should not be made directly in a host project, except perhaps in maintenance branches. -Please visit - - http://public.kitware.com/Wiki/KWSys/Git +KWSys uses `Kitware's GitLab Instance`_ to manage development and code review. +To contribute patches: -to contribute changes directly to KWSys upstream. Once changes are -reviewed, tested, and integrated there then the copies of KWSys within -dependent projects can be updated to get the changes. +#. Fork the upstream `KWSys Repository`_ into a personal account. +#. Base all new work on the upstream ``master`` branch. +#. Run ``./SetupForDevelopment.sh`` in new local work trees. +#. Create commits making incremental, distinct, logically complete changes. +#. Push a topic branch to a personal repository fork on GitLab. +#. Create a GitLab Merge Request targeting the upstream ``master`` branch. -Issues -====== +Once changes are reviewed, tested, and integrated to KWSys upstream then +copies of KWSys within dependent projects can be updated to get the changes. -KWSys has no independent issue tracker. After encountering an issue -(bug) please try to submit a patch using the above instructions. -Otherwise please report the issue to the tracker for the project that -hosts the copy of KWSys in which the problem was found. +.. _`Kitware's GitLab Instance`: https://gitlab.kitware.com +.. _`KWSys Repository`: https://gitlab.kitware.com/utils/kwsys Code Style ========== @@ -36,7 +36,6 @@ See also the `clang-format.bash`_ script. .. _`.clang-format`: .clang-format .. _`clang-format.bash`: clang-format.bash - License ======= |