| 1 |
Contributing to KWSys |
| 2 |
********************* |
| 3 |
|
| 4 |
Patches |
| 5 |
======= |
| 6 |
|
| 7 |
KWSys is kept in its own Git repository and shared by several projects |
| 8 |
via copies in their source trees. Changes to KWSys should not be made |
| 9 |
directly in a host project, except perhaps in maintenance branches. |
| 10 |
|
| 11 |
KWSys uses `Kitware's GitLab Instance`_ to manage development and code review. |
| 12 |
To contribute patches: |
| 13 |
|
| 14 |
#. Fork the upstream `KWSys Repository`_ into a personal account. |
| 15 |
#. Base all new work on the upstream ``master`` branch. |
| 16 |
#. Run ``./SetupForDevelopment.sh`` in new local work trees. |
| 17 |
#. Create commits making incremental, distinct, logically complete changes. |
| 18 |
#. Push a topic branch to a personal repository fork on GitLab. |
| 19 |
#. Create a GitLab Merge Request targeting the upstream ``master`` branch. |
| 20 |
|
| 21 |
Once changes are reviewed, tested, and integrated to KWSys upstream then |
| 22 |
copies of KWSys within dependent projects can be updated to get the changes. |
| 23 |
|
| 24 |
.. _`Kitware's GitLab Instance`: https://gitlab.kitware.com |
| 25 |
.. _`KWSys Repository`: https://gitlab.kitware.com/utils/kwsys |
| 26 |
|
| 27 |
Code Style |
| 28 |
========== |
| 29 |
|
| 30 |
We use `clang-format`_ version **15** to define our style for C++ code in |
| 31 |
the KWSys source tree. See the `.clang-format`_ configuration file for |
| 32 |
our style settings. Use the `clang-format.bash`_ script to format source |
| 33 |
code. It automatically runs ``clang-format`` on the set of source files |
| 34 |
for which we enforce style. The script also has options to format only |
| 35 |
a subset of files, such as those that are locally modified. |
| 36 |
|
| 37 |
.. _`clang-format`: http://clang.llvm.org/docs/ClangFormat.html |
| 38 |
.. _`.clang-format`: .clang-format |
| 39 |
.. _`clang-format.bash`: clang-format.bash |
| 40 |
|
| 41 |
License |
| 42 |
======= |
| 43 |
|
| 44 |
We do not require any formal copyright assignment or contributor license |
| 45 |
agreement. Any contributions intentionally sent upstream are presumed |
| 46 |
to be offered under terms of the OSI-approved BSD 3-clause License. |
| 47 |
See `Copyright.txt`_ for details. |
| 48 |
|
| 49 |
.. _`Copyright.txt`: Copyright.txt |