[PATCH v3] Configure Git contribution guidelines for github.com

From: Lars Schneider <larsxschneider@gmail.com>
Date: Jun 14, 2017, 07:35 UTC
Message-ID: <20170614073536.45498-1-larsxschneider@gmail.com>

Many open source projects use github.com for their contribution process. Although we mirror the Git core repository to github.com [1] we do not use any other github.com service. This is unknown/unexpected to a number of (potential) contributors and consequently they create Pull Requests against our mirror with their contributions. These Pull Requests become stale. This is frustrating to them as they think we ignore them and it is also unsatisfactory for us as we miss potential code improvements and/or new contributors.

GitHub contribution guidelines and a GitHub Pull Request template that is visible to every Pull Request creator can be configured with special files in a Git repository [2]. Let's make use of this!

[1] https://github.com/git/git [2] https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/

Signed-off-by: Lars Schneider <larsxschneider@gmail.com>
---

Hi,

changes since v2:
* removed mailing list address, added link with mailing list explanations
* fixed grammar nits

You can see a preview here: https://github.com/larsxschneider/git/compare/master...larsxschneider-patch-1?quick_pull=1

Thanks, Lars

Notes:
    Base Ref: master
    Web-Diff: https://github.com/larsxschneider/git/commit/ba3e711f9e
    Checkout: git fetch https://github.com/larsxschneider/git contrib-guide-v3 && git checkout ba3e711f9e

    Interdiff (v2..v3):

    diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
    index fc397bb8fc..5a0fb679b1 100644
    --- a/.github/CONTRIBUTING.md
    +++ b/.github/CONTRIBUTING.md
    @@ -1,8 +1,8 @@
     ## Contributing to Git

    -Thanks for taking the time to contribute to Git! Please be advised, that the
    +Thanks for taking the time to contribute to Git! Please be advised that the
     Git community does not use github.com for their contributions. Instead, we use
    -a mailing list (git@vger.kernel.org) for code submissions, code
    +a [mailing list](https://git-scm.com/community/) for code submissions, code
     reviews, and bug reports.

     Nevertheless, you can use [submitGit](http://submitgit.herokuapp.com/) to
    diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
    index 2b617f4c25..c81bfb343f 100644
    --- a/.github/PULL_REQUEST_TEMPLATE.md
    +++ b/.github/PULL_REQUEST_TEMPLATE.md
    @@ -1,7 +1,7 @@
    -Thanks for taking the time to contribute to Git! Please be advised, that the
    -Git community does not use github.com for their contributions. Instead, we use
    -a mailing list (git@vger.kernel.org) for code submissions, code reviews, and
    -bug reports. Nevertheless, you can use submitGit to conveniently send your Pull
    -Requests commits to our mailing list.
    +Thanks for taking the time to contribute to Git! Please be advised that the
    +Git community does not use github.com for their contributions. Instead,
    +we use a mailing list for code submissions, code reviews, and bug reports.
    +Nevertheless, you can use submitGit to conveniently send your Pull Requests
    +commits to our mailing list.

     Please read the "guidelines for contributing" linked above!

 .github/CONTRIBUTING.md          | 19 +++++++++++++++++++
 .github/PULL_REQUEST_TEMPLATE.md |  7 +++++++
 2 files changed, 26 insertions(+)
 create mode 100644 .github/CONTRIBUTING.md
 create mode 100644 .github/PULL_REQUEST_TEMPLATE.md

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 0000000000..5a0fb679b1
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,19 @@
+## Contributing to Git
+
+Thanks for taking the time to contribute to Git! Please be advised that the
+Git community does not use github.com for their contributions. Instead, we use
+a [mailing list](https://git-scm.com/community/) for code submissions, code
+reviews, and bug reports.
+
+Nevertheless, you can use [submitGit](http://submitgit.herokuapp.com/) to
+conveniently send your Pull Requests commits to our mailing list.
+
+Please read ["A note from the maintainer"](https://git.kernel.org/pub/scm/git/git.git/plain/MaintNotes?h=todo)
+to learn how the Git project is managed, and how you can work with it.
+In addition, we highly recommend you to read [our submission guidelines](../Documentation/SubmittingPatches).
+
+If you prefer video, then [this talk](https://www.youtube.com/watch?v=Q7i_qQW__q4&feature=youtu.be&t=6m4s)
+might be useful to you as the presenter walks you through the contribution
+process by example.
+
+Your friendly Git community!
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000000..c81bfb343f
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,7 @@
+Thanks for taking the time to contribute to Git! Please be advised that the
+Git community does not use github.com for their contributions. Instead,
+we use a mailing list for code submissions, code reviews, and bug reports.
+Nevertheless, you can use submitGit to conveniently send your Pull Requests
+commits to our mailing list.
+
+Please read the "guidelines for contributing" linked above!

base-commit: 8d1b10321b20bd2a73a5b561cfc3cf2e8051b70b
--
2.13.0