From 9c3eacf8237ee86006e77d8a307b01401988e0a1 Mon Sep 17 00:00:00 2001 From: Brad King <brad.king@kitware.com> Date: Mon, 15 Dec 2014 15:17:23 -0500 Subject: [PATCH] Add CONTRIBUTING.rst file with instructions to contribute Also link to the file from the README.txt file. Change-Id: I7dd74ce2a6d575a5503755d1aba2983907ccb7c9 --- .gitattributes | 2 ++ CONTRIBUTING.rst | 35 +++++++++++++++++++++++++++++++++++ README.txt | 2 ++ 3 files changed, 39 insertions(+) create mode 100644 CONTRIBUTING.rst diff --git a/.gitattributes b/.gitattributes index 33bff1ed..9578d975 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 00000000..e097b766 --- /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 ba03f8dd..b8191f78 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. -- GitLab