{"thread":{"id":"46166","subject":"[PATCH v2] Configure Git contribution guidelines for github.com","startedAt":"2017-06-13T08:18:36Z","lastAt":"2017-06-14T10:23:18Z","messageCount":5,"participants":["Lars Schneider","Jeff King","Junio C Hamano"],"isPatch":true,"patchVersion":2,"patchTotal":null},"messages":[{"id":"322059","messageId":"20170613081807.33196-1-larsxschneider@gmail.com","threadId":"46166","inReplyTo":null,"subject":"[PATCH v2] Configure Git contribution guidelines for github.com","fromName":"Lars Schneider","fromEmail":"larsxschneider@gmail.com","sentAt":"2017-06-13T08:18:07Z","receivedAt":"2017-06-13T08:18:36Z","isPatch":true,"sender":{"key":"larsxschneider@gmail.com","avatar":"https://avatars.githubusercontent.com/u/477434?v=4"},"body":"Many open source projects use github.com for their contribution process.\nAlthough we mirror the Git core repository to github.com [1] we do not\nuse any other github.com service. This is unknown/unexpected to a\nnumber of (potential) contributors and consequently they create Pull\nRequests against our mirror with their contributions. These Pull\nRequests become stale. This is frustrating to them as they think we\nignore them and it is also unsatisfactory for us as we miss potential\ncode improvements and/or new contributors.\n\nGitHub contribution guidelines and a GitHub Pull Request template that\nis visible to every Pull Request creator can be configured with special\nfiles in a Git repository [2]. Let's make use of this!\n\n[1] https://github.com/git/git\n[2] https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/\n\nSigned-off-by: Lars Schneider \n---\n\nHi,\n\nchanges since v1:\n* mention submitGit\n* link to mailing list address instead of mailing list archive\n* reformat long lines\n* move \"read\" out of link title\n* use kernel.org repo for \"A note from the maintainer\"\n* reference \"A note from the maintainer\" with the correct name\n\nYou can see a preview here:\nhttps://github.com/larsxschneider/git/compare/master...larsxschneider-patch-1?quick_pull=1\n\nThanks,\nLars\n\n\nNotes:\n Base Ref: master\n Web-Diff: https://github.com/larsxschneider/git/commit/c438291da7\n Checkout: git fetch https://github.com/larsxschneider/git contrib-guide-v2 && git checkout c438291da7\n\n .github/CONTRIBUTING.md | 19 +++++++++++++++++++\n .github/PULL_REQUEST_TEMPLATE.md | 7 +++++++\n 2 files changed, 26 insertions(+)\n create mode 100644 .github/CONTRIBUTING.md\n create mode 100644 .github/PULL_REQUEST_TEMPLATE.md\n\ndiff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md\nnew file mode 100644\nindex 0000000000..fc397bb8fc\n--- /dev/null\n+++ b/.github/CONTRIBUTING.md\n@@ -0,0 +1,19 @@\n+## Contributing to Git\n+\n+Thanks for taking the time to contribute to Git! Please be advised, that the\n+Git community does not use github.com for their contributions. Instead, we use\n+a mailing list (git@vger.kernel.org) for code submissions, code\n+reviews, and bug reports.\n+\n+Nevertheless, you can use [submitGit](http://submitgit.herokuapp.com/) to\n+conveniently send your Pull Requests commits to our mailing list.\n+\n+Please read [\"A note from the maintainer\"](https://git.kernel.org/pub/scm/git/git.git/plain/MaintNotes?h=todo)\n+to learn how the Git project is managed, and how you can work with it.\n+In addition, we highly recommend you to read [our submission guidelines](../Documentation/SubmittingPatches).\n+\n+If you prefer video, then [this talk](https://www.youtube.com/watch?v=Q7i_qQW__q4&feature=youtu.be&t=6m4s)\n+might be useful to you as the presenter walks you through the contribution\n+process by example.\n+\n+Your friendly Git community!\ndiff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md\nnew file mode 100644\nindex 0000000000..2b617f4c25\n--- /dev/null\n+++ b/.github/PULL_REQUEST_TEMPLATE.md\n@@ -0,0 +1,7 @@\n+Thanks for taking the time to contribute to Git! Please be advised, that the\n+Git community does not use github.com for their contributions. Instead, we use\n+a mailing list (git@vger.kernel.org) for code submissions, code reviews, and\n+bug reports. Nevertheless, you can use submitGit to conveniently send your Pull\n+Requests commits to our mailing list.\n+\n+Please read the \"guidelines for contributing\" linked above!\n\nbase-commit: 8d1b10321b20bd2a73a5b561cfc3cf2e8051b70b\n--\n2.13.0\n\n"},{"id":"322060","messageId":"20170613090427.igjz7erniblh3wie@sigill.intra.peff.net","threadId":"46166","inReplyTo":"20170613081807.33196-1-larsxschneider@gmail.com","subject":"Re: [PATCH v2] Configure Git contribution guidelines for github.com","fromName":"Jeff King","fromEmail":"peff@peff.net","sentAt":"2017-06-13T09:04:27Z","receivedAt":"2017-06-13T09:04:38Z","isPatch":true,"sender":{"key":"peff@peff.net","avatar":"https://avatars.githubusercontent.com/u/45925?v=4"},"body":"On Tue, Jun 13, 2017 at 10:18:07AM +0200, Lars Schneider wrote:\n\n> changes since v1:\n> * mention submitGit\n> * link to mailing list address instead of mailing list archive\n\nYou might want to link to https://git-scm.com/community/, which has a\nsection on the mailing list at the top. It gives the list address but\nalso talks about the archive, that you can send to it without\nsubscribing, etc.\n\n> * reformat long lines\n\nI think this is OK. For CONTRIBUTING.md, GitHub re-wraps. In the pull\nrequest template itself, though, the newlines become hard-wraps. But we\nwouldn't generally expect those lines to remain in the final PR text\nanyway, so it shouldn't really matter.\n\nThat's actually one annoyance I have with PR and issue templates like\nthis: the submitter has to manually delete them. But there's not really\na better way to get people's attention. The link to CONTRIBUTING is by\nfar not enough in my experience (I had to put a template in\ngit/git-scm.com for people to top submitting Git bugs).\n\nThe text itself looks good, but two minor grammar nits:\n\n> diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md\n> new file mode 100644\n> index 0000000000..fc397bb8fc\n> --- /dev/null\n> +++ b/.github/CONTRIBUTING.md\n> @@ -0,0 +1,19 @@\n> +## Contributing to Git\n> +\n> +Thanks for taking the time to contribute to Git! Please be advised, that the\n> +Git community does not use github.com for their contributions. Instead, we use\n> +a mailing list (git@vger.kernel.org) for code submissions, code\n> +reviews, and bug reports.\n\nI think the comma after \"advised\" is unnecessary (you could also drop\n\"that\" to turn the first part into an introductory clause, but I think\nit reads better with as \"Please be advised that\").\n\n> diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md\n> new file mode 100644\n> index 0000000000..2b617f4c25\n> --- /dev/null\n> +++ b/.github/PULL_REQUEST_TEMPLATE.md\n> @@ -0,0 +1,7 @@\n> +Thanks for taking the time to contribute to Git! Please be advised, that the\n\nDitto here.\n\n-Peff\n"},{"id":"322198","messageId":"FEFF27D2-1A56-4F37-8114-126613C144A0@gmail.com","threadId":"46166","inReplyTo":"20170613090427.igjz7erniblh3wie@sigill.intra.peff.net","subject":"Re: [PATCH v2] Configure Git contribution guidelines for github.com","fromName":"Lars Schneider","fromEmail":"larsxschneider@gmail.com","sentAt":"2017-06-14T07:28:03Z","receivedAt":"2017-06-14T07:28:10Z","isPatch":true,"sender":{"key":"larsxschneider@gmail.com","avatar":"https://avatars.githubusercontent.com/u/477434?v=4"},"body":"\n> On 13 Jun 2017, at 11:04, Jeff King wrote:\n> \n> On Tue, Jun 13, 2017 at 10:18:07AM +0200, Lars Schneider wrote:\n> \n>> changes since v1:\n>> * mention submitGit\n>> * link to mailing list address instead of mailing list archive\n> \n> You might want to link to https://git-scm.com/community/, which has a\n> section on the mailing list at the top. It gives the list address but\n> also talks about the archive, that you can send to it without\n> subscribing, etc.\n\nAgreed. I removed the mailing list email address as this is not\nuseful until you have subscribed to the list.\n\n> \n> The text itself looks good, but two minor grammar nits:\n> \n>> diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md\n>> new file mode 100644\n>> index 0000000000..fc397bb8fc\n>> --- /dev/null\n>> +++ b/.github/CONTRIBUTING.md\n>> @@ -0,0 +1,19 @@\n>> +## Contributing to Git\n>> +\n>> +Thanks for taking the time to contribute to Git! Please be advised, that the\n>> +Git community does not use github.com for their contributions. Instead, we use\n>> +a mailing list (git@vger.kernel.org) for code submissions, code\n>> +reviews, and bug reports.\n> \n> I think the comma after \"advised\" is unnecessary (you could also drop\n> \"that\" to turn the first part into an introductory clause, but I think\n> it reads better with as \"Please be advised that\").\n\nAgreed!\n\nThank you,\nLars\n\n"},{"id":"322216","messageId":"xmqqk24e51my.fsf@gitster.mtv.corp.google.com","threadId":"46166","inReplyTo":"FEFF27D2-1A56-4F37-8114-126613C144A0@gmail.com","subject":"Re: [PATCH v2] Configure Git contribution guidelines for github.com","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2017-06-14T10:01:25Z","receivedAt":"2017-06-14T10:01:33Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Lars Schneider writes:\n\n>> On 13 Jun 2017, at 11:04, Jeff King wrote:\n>> \n>> On Tue, Jun 13, 2017 at 10:18:07AM +0200, Lars Schneider wrote:\n>> \n>>> changes since v1:\n>>> * mention submitGit\n>>> * link to mailing list address instead of mailing list archive\n>> \n>> You might want to link to https://git-scm.com/community/, which has a\n>> section on the mailing list at the top. It gives the list address but\n>> also talks about the archive, that you can send to it without\n>> subscribing, etc.\n>\n> Agreed. I removed the mailing list email address as this is not\n> useful until you have subscribed to the list.\n\nWait a minite. As Peff explained above, you *can* send to it\nwithout subscribing, so \"as this is not useful until you have\nsubscribed\" is quite wrong, no?\n\n>> The text itself looks good, but two minor grammar nits:\n>> ... \n>\n> Agreed!\n\nThis I think I've already squashed in to v2 before pushing the\nresult out.\n\nI do not terribly mind what you did in v3 to the list address,\nand I do agree with Peff that mentioning the \"community\" page\nis a good idea. But\n\n Git community does not use github.com for their contributions. Instead, we use\n a [mailing list](https://git-scm.com/community/) for code submissions,...\n ... and bug reports.\n\nlooks quite wrong. If it were\n\n Git community does not use github.com for their contributions. Instead, we use\n a [mailing list](mailto:git@vger.kernel.org) for code submissions,...\n ... and bug reports. See [the community page](https://git-scm.com/community/)\n for further information.\n\nI won't find it questionable at all, though.\n"},{"id":"322224","messageId":"F6A28A03-241E-4201-B0B1-DBC0FAC4329A@gmail.com","threadId":"46166","inReplyTo":"xmqqk24e51my.fsf@gitster.mtv.corp.google.com","subject":"Re: [PATCH v2] Configure Git contribution guidelines for github.com","fromName":"Lars Schneider","fromEmail":"larsxschneider@gmail.com","sentAt":"2017-06-14T10:23:10Z","receivedAt":"2017-06-14T10:23:18Z","isPatch":true,"sender":{"key":"larsxschneider@gmail.com","avatar":"https://avatars.githubusercontent.com/u/477434?v=4"},"body":"\n> On 14 Jun 2017, at 12:01, Junio C Hamano wrote:\n> \n> Lars Schneider writes:\n> \n>>> On 13 Jun 2017, at 11:04, Jeff King wrote:\n>>> \n>>> On Tue, Jun 13, 2017 at 10:18:07AM +0200, Lars Schneider wrote:\n>>> \n>>>> changes since v1:\n>>>> * mention submitGit\n>>>> * link to mailing list address instead of mailing list archive\n>>> \n>>> You might want to link to https://git-scm.com/community/, which has a\n>>> section on the mailing list at the top. It gives the list address but\n>>> also talks about the archive, that you can send to it without\n>>> subscribing, etc.\n>> \n>> Agreed. I removed the mailing list email address as this is not\n>> useful until you have subscribed to the list.\n> \n> Wait a minite. As Peff explained above, you *can* send to it\n> without subscribing, so \"as this is not useful until you have\n> subscribed\" is quite wrong, no?\n\nOh, I didn't know that! I \"subscribed\" before sending my first\nmessage :)\n\n\n> \n>>> The text itself looks good, but two minor grammar nits:\n>>> ... \n>> \n>> Agreed!\n> \n> This I think I've already squashed in to v2 before pushing the\n> result out.\n> \n> I do not terribly mind what you did in v3 to the list address,\n> and I do agree with Peff that mentioning the \"community\" page\n> is a good idea. But\n> \n> Git community does not use github.com for their contributions. Instead, we use\n> a [mailing list](https://git-scm.com/community/) for code submissions,...\n> ... and bug reports.\n> \n> looks quite wrong. If it were\n> \n> Git community does not use github.com for their contributions. Instead, we use\n> a [mailing list](mailto:git@vger.kernel.org) for code submissions,...\n> ... and bug reports. See [the community page](https://git-scm.com/community/)\n> for further information.\n\nLooks good to me (minor nit: maybe s/the community page/our community page/ for a\nmore personal touch?). However, I would apply these changes only to CONTRIBUTING.md.\nMarkdown links wouldn't work in PULL_REQUEST_TEMPLATE.md as the user would see\nthe Markdown in plain text and not rendered.\n\nExample here:\nhttps://github.com/larsxschneider/git/compare/master...larsxschneider-patch-1?quick_pull=1\n\nThanks,\nLars"}]}