diff options
| author | KWSys Upstream <kwrobot@kitware.com> | 2016-12-14 16:15:00 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2016-12-14 16:16:55 (GMT) |
| commit | a9ea66bd66db0f0ad9b0b59d617739ad6a04cebf (patch) | |
| tree | 48fe0a559802900eedf43abc38d483f65f270abc /CONTRIBUTING.rst | |
| parent | 1b50bd3f5c1f608a84df89c2f5e187a53f0be31d (diff) | |
| download | CMake-a9ea66bd66db0f0ad9b0b59d617739ad6a04cebf.zip CMake-a9ea66bd66db0f0ad9b0b59d617739ad6a04cebf.tar.gz CMake-a9ea66bd66db0f0ad9b0b59d617739ad6a04cebf.tar.bz2 | |
KWSys 2016-12-14 (95a7e234)
Code extracted from:
https://gitlab.kitware.com/utils/kwsys.git
at commit 95a7e234ffd0c6bdfaa8b21c59a119198c050164 (master).
Upstream Shortlog
-----------------
Ben Boeckel (1):
e0967411 Add a script to help update third-party sources
Brad King (10):
98505f79 Add script to update GitSetup from upstream
365edba8 GitSetup: Tell Git not to export .gitattributes
41a7fe5b Add pre-commit hook to check whether SetupForDevelopment must re-run
17a1200c Convert developer setup scripts away from Gerrit Code Review
5f206c3a Tell Git to use a distinct conflict marker size in `.rst` files
33f828d4 README: Convert from `.txt` to `.rst` markup
56b707dd README: Add section about reporting bugs
140357ea CONTRIBUTING: Document contribution through the Kitware GitLab Instance
4b7bf8e4 Tell Git not to export any `.sh` or `.bash` scripts
e25eb8dc CONTRIBUTING: Add step for running developer setup script
GitSetup Upstream (3):
fed3d191 GitSetup 2012-09-27 (341043cf)
a0144297 GitSetup 2016-12-13 (8af10838)
868c1e68 GitSetup 2016-12-13 (cd5ada6d)
Diffstat (limited to 'CONTRIBUTING.rst')
| -rw-r--r-- | CONTRIBUTING.rst | 29 |
1 files changed, 14 insertions, 15 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 47dffee..d71832a 100644 --- a/CONTRIBUTING.rst +++ b/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 ======= |