Re: [PATCH v2] Configure Git contribution guidelines for github.com
- From
Jeff King <peff@peff.net>
- Date
- Jun 13, 2017, 09:04 UTC
- Message-ID
- <20170613090427.igjz7erniblh3wie@sigill.intra.peff.net>
- In-Reply-To
- <20170613081807.33196-1-larsxschneider@gmail.com>
On Tue, Jun 13, 2017 at 10:18:07AM +0200, Lars Schneider wrote:
> changes since v1: > * mention submitGit > * link to mailing list address instead of mailing list archive
You might want to link to https://git-scm.com/community/, which has a section on the mailing list at the top. It gives the list address but also talks about the archive, that you can send to it without subscribing, etc.
> * reformat long lines
I think this is OK. For CONTRIBUTING.md, GitHub re-wraps. In the pull request template itself, though, the newlines become hard-wraps. But we wouldn't generally expect those lines to remain in the final PR text anyway, so it shouldn't really matter.
That's actually one annoyance I have with PR and issue templates like this: the submitter has to manually delete them. But there's not really a better way to get people's attention. The link to CONTRIBUTING is by far not enough in my experience (I had to put a template in git/git-scm.com for people to top submitting Git bugs).
The text itself looks good, but two minor grammar nits:
Show 12 quoted lines
> diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md > new file mode 100644 > index 0000000000..fc397bb8fc > --- /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 (git@vger.kernel.org) for code submissions, code > +reviews, and bug reports.
I think the comma after "advised" is unnecessary (you could also drop "that" to turn the first part into an introductory clause, but I think it reads better with as "Please be advised that").
Show 7 quoted lines
> diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md > new file mode 100644 > index 0000000000..2b617f4c25 > --- /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
Ditto here.
-Peff