diff --git a/.gitattributes b/.gitattributes index 33bff1ed6afbdec21586eb2bbf440b6bba46e2df..9578d975bac21457cfda45ef53d29b1ba3deadb0 100644 --- a/.gitattributes +++ b/.gitattributes @@ -3,6 +3,8 @@ /GitSetup export-ignore /SetupForDevelopment.sh export-ignore eol=lf +/CONTRIBUTING.rst conflict-marker-size=78 + *.c whitespace=tab-in-indent,no-lf-at-eof *.h whitespace=tab-in-indent,no-lf-at-eof *.h.in whitespace=tab-in-indent,no-lf-at-eof diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000000000000000000000000000000000000..e097b766f1d35a76a6926e9c4dd905d9aa36dd6f --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,35 @@ +Contributing to KWSys +********************* + +Overview +======== + +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 + +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. + +Issues +====== + +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. + +License +======= + +We do not require any formal copyright assignment or contributor license +agreement. Any contributions intentionally sent upstream are presumed +to be offerred under terms of the OSI-approved BSD 3-clause License. +See `Copyright.txt`_ for details. + +.. _`Copyright.txt`: Copyright.txt diff --git a/README.txt b/README.txt index ba03f8ddee2a235f1c18c25a1970df28a4435bfe..b8191f7848f6a3f1ffc365acc50ef0a143b8e4c7 100644 --- a/README.txt +++ b/README.txt @@ -8,3 +8,5 @@ details. You are probably reading this file in the source tree of a surrounding project. In that case, see "../README.kwsys" for details of using KWSys in your project. + +See CONTRIBUTING.rst for instructions to contribute KWSys changes.