From: Lars Schneider <larsxschneider@gmail.com>
To: git@vger.kernel.org
Cc: gitster@pobox.com, peff@peff.net
Subject: [PATCH v1] Configure Git contribution guidelines for github.com
Date: Fri, 9 Jun 2017 16:21:51 +0200 [thread overview]
Message-ID: <20170609142151.94811-1-larsxschneider@gmail.com> (raw)
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 stall [2]. 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 offers a way to notify Pull Request contributors about the
contribution guidelines for a project [3]. Let's make use of this!
[1] https://github.com/git/git
[2] https://github.com/git/git/pulls
[3] https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/
Signed-off-by: Lars Schneider <larsxschneider@gmail.com>
---
Hi,
I am perfectly aware that adding a ".github" directory in the Git core
tree is ugly. However, I believe the benefits ("well informed new
contributors") outweigh the injury.
You can see how a github.com Pull Request creation window would like here:
https://github.com/larsxschneider/git/compare/master...larsxschneider-patch-1?quick_pull=1
I added a link that jumps to a part my GitMerge 2017 talk which explains
Git core contributions from my point view. Although I tried my best, the
presentation is not perfect and might not reflect the view of the Git
community. I wouldn't have a problem at all with removing the link.
I also did not break the lines in the .github/*.md files as I thought it
renders nicer on the github.com web interface. I am happy to change that,
too, though.
Cheers,
Lars
Notes:
Base Ref: master
Web-Diff: https://github.com/larsxschneider/git/commit/d859be5016
Checkout: git fetch https://github.com/larsxschneider/git contrib-guide-v1 && git checkout d859be5016
.github/CONTRIBUTING.md | 10 ++++++++++
.github/PULL_REQUEST_TEMPLATE.md | 3 +++
2 files changed, 13 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..8d01be6a71
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,10 @@
+## 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](http://public-inbox.org/git/) for code submissions, code reviews, and bug reports.
+
+Please [read the maintainer notes](http://repo.or.cz/w/git.git?a=blob_plain;f=MaintNotes;hb=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 Git community
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000000..c737a64620
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,3 @@
+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.
+
+Please read the "guidelines for contributing" linked above!
base-commit: 8d1b10321b20bd2a73a5b561cfc3cf2e8051b70b
--
2.13.0
next reply other threads:[~2017-06-09 14:23 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-06-09 14:21 Lars Schneider [this message]
2017-06-09 16:18 ` [PATCH v1] Configure Git contribution guidelines for github.com Ævar Arnfjörð Bjarmason
2017-06-09 16:29 ` Lars Schneider
2017-06-10 1:44 ` Junio C Hamano
2017-06-09 17:03 ` Jonathan Nieder
2017-06-10 1:51 ` Junio C Hamano
2017-06-13 7:57 ` Lars Schneider
2017-06-10 7:35 ` Jeff King
2017-06-13 7:51 ` Lars Schneider
2017-06-10 12:48 ` Philip Oakley
2017-06-12 15:52 ` Junio C Hamano
2017-06-13 7:45 ` Lars Schneider
2017-06-15 8:09 ` Ævar Arnfjörð Bjarmason
2017-06-15 16:43 ` Junio C Hamano
2017-06-15 17:31 ` Andreas Heiduk
2017-06-15 17:59 ` Junio C Hamano
2017-06-13 7:48 ` Lars Schneider
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20170609142151.94811-1-larsxschneider@gmail.com \
--to=larsxschneider@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=peff@peff.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).