add PR template in order to simplify new developers cooperate properly if they open PR. discussed here: https://sourceforge.net/p/openvpn/mailman/message/35601310/
PATCH 1/1 add PR template in order to simplify new developers cooperate properly if they open PR. discussed here: https://sourceforge.net/p/openvpn/mailman/message/35601310/
--- .github/PULL_REQUEST_TEMPLATE.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md
.github/PULL_REQUEST_TEMPLATE.md new file +8 -0
@@ -0,0 +1,8 @@ +# Thank you for your contribution + +You are welcome to open PR, but they are used for discussion only. All +patches must eventually go to the openvpn-devel mailing list for review. +For details, see these Wiki articles: + +* https://community.openvpn.net/openvpn/wiki/Contributing +* https://community.openvpn.net/openvpn/wiki/DeveloperDocumentation
Signature · 1 line
2.5.5
Il 13/01/2017 10:50, Ilya Shipitsin ha scritto:
Quoted 12 lines
--- .github/PULL_REQUEST_TEMPLATE.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md.github/PULL_REQUEST_TEMPLATE.md new file +0
-0
.github/PULL_REQUEST_TEMPLATE.md line 8
Quoted 8 lines
.github/PULL_REQUEST_TEMPLATE.md new file +8
-0@@ -0,0 +1,8 @@ +# Thank you for your contribution + +You are welcome to open PR, but they are used for discussion only. All +patches must eventually go to the openvpn-devel mailing list for review. +For details, see these Wiki articles: + +* https://community.openvpn.net/openvpn/wiki/Contributing +* https://community.openvpn.net/openvpn/wiki/DeveloperDocumentation
Based on testing in the travis-openssl-test repository the template works as intended, so ACK on that part.
Any comments on the text itself?
Signature · 5 lines
Samuli Seppänen Community Manager OpenVPN Technologies, Inc irc freenode net: mattock
Quoted 25 lines · Samuli Seppänen
Il 13/01/2017 10:50, Ilya Shipitsin ha scritto:
Quoted 12 lines
--- .github/PULL_REQUEST_TEMPLATE.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md.github/PULL_REQUEST_TEMPLATE.md new file +0
-0.github/PULL_REQUEST_TEMPLATE.md line 8
Quoted 8 lines
.github/PULL_REQUEST_TEMPLATE.md new file +8
-0@@ -0,0 +1,8 @@ +# Thank you for your contribution + +You are welcome to open PR, but they are used for discussion only. All +patches must eventually go to the openvpn-devel mailing list for review. +For details, see these Wiki articles: + +* https://community.openvpn.net/openvpn/wiki/Contributing +* https://community.openvpn.net/openvpn/wiki/DeveloperDocumentationBased on testing in the travis-openssl-test repository the template works as intended, so ACK on that part.
Quoted 1 line
Any comments on the text itself?
How does this work with branches? Do we need to say that new patches should go into the master branch primarily, unless it is fixing a bug or another issue which is only relevant for specific release branches?
Signature · 4 lines
kind regards, David Sommerseth OpenVPN Technologies, Inc
2017-01-21 0:24 GMT+05:00 David Sommerseth <
[email protected]...>:
Quoted 28 lines · Samuli Seppänen
Quoted 7 lines
Il 13/01/2017 10:50, Ilya Shipitsin ha scritto:
.github/PULL_REQUEST_
Quoted 6 lines
--- .github/PULL_REQUEST_TEMPLATE.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md.github/PULL_REQUEST_ renamed from .github/PULL_REQUEST_TEMPLATE.md +0
-0TEMPLATE.md
Quoted 9 lines
.github/PULL_REQUEST_TEMPLATE.md line 4
Quoted 9 lines
new file mode 100644
index 0000000..d0cfd7f.github/PULL_REQUEST_TEMPLATE.md new file +4
-0@@ -0,0 +1,8 @@ +# Thank you for your contribution + +You are welcome to open PR, but they are used for discussion only. All +patches must eventually go to the openvpn-devel mailing list forreview.
Quoted 9 lines
.github/PULL_REQUEST_TEMPLATE.md line 8
Quoted 5 lines
.github/PULL_REQUEST_TEMPLATE.md new file +4
-0+For details, see these Wiki articles: + +* https://community.openvpn.net/openvpn/wiki/Contributing +* https://community.openvpn.net/openvpn/wiki/DeveloperDocumentationBased on testing in the travis-openssl-test repository the template works as intended, so ACK on that part.
Quoted 6 lines
Quoted 1 line
Any comments on the text itself?
How does this work with branches? Do we need to say that new patches should go into the master branch primarily, unless it is fixing a bug or another issue which is only relevant for specific release branches?
we can put such information to
https://community.openvpn.net/openvpn/wiki/Contributing
https://community.openvpn.net/openvpn/wiki/DeveloperDocumentation
I would leave PR template skinny
Quoted 10 lines
--
kind regards,David Sommerseth
OpenVPN Technologies, Inc
can we merge it ?
@mattock ?
2017-01-21 13:47 GMT+05:00 Илья Шипицин <[email protected]...>:
Quoted 61 lines
2017-01-21 0:24 GMT+05:00 David Sommerseth <[email protected]... topphemmelig.net>:
Quoted 28 lines · Samuli Seppänen
Quoted 7 lines
Il 13/01/2017 10:50, Ilya Shipitsin ha scritto:
Review
Quoted 6 lines
--- .github/PULL_REQUEST_TEMPLATE.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md(quoted diff) +0
-0
b/.github/PULL_REQUEST_TEMPLATE.mdQuoted 9 lines
.github/PULL_REQUEST_TEMPLATE.md line 4
Quoted 9 lines
new file mode 100644
index 0000000..d0cfd7f.github/PULL_REQUEST_TEMPLATE.md new file +4
-0@@ -0,0 +1,8 @@ +# Thank you for your contribution + +You are welcome to open PR, but they are used for discussion only. All +patches must eventually go to the openvpn-devel mailing list forreview.
Quoted 9 lines
.github/PULL_REQUEST_TEMPLATE.md line 8
Quoted 5 lines
.github/PULL_REQUEST_TEMPLATE.md new file +4
-0+For details, see these Wiki articles: + +* https://community.openvpn.net/openvpn/wiki/Contributing +* https://community.openvpn.net/openvpn/wiki/DeveloperDocumentationBased on testing in the travis-openssl-test repository the template works as intended, so ACK on that part.
Quoted 6 lines
Quoted 1 line
Any comments on the text itself?
How does this work with branches? Do we need to say that new patches should go into the master branch primarily, unless it is fixing a bug or another issue which is only relevant for specific release branches?
we can put such information to
https://community.openvpn.net/openvpn/wiki/Contributing
https://community.openvpn.net/openvpn/wiki/DeveloperDocumentationI would leave PR template skinny
Quoted 10 lines
--
kind regards,David Sommerseth
OpenVPN Technologies, Inc
I agree with you on keeping the pull request template minimal and having the more fine-grained information in Trac.
ACK.
Quoted 71 lines · Илья Шипицин
can we merge it ?
@mattock ?2017-01-21 13:47 GMT+05:00 Илья Шипицин <[email protected]... <mailto:[email protected]...>>:
2017-01-21 0:24 GMT+05:00 David Sommerseth <[email protected]... <mailto:[email protected]...>>: On 13/01/17 10:05, Samuli Seppänen wrote: > Il 13/01/2017 10:50, Ilya Shipitsin ha scritto: >> --- >> .github/PULL_REQUEST_TEMPLATE.md | 8 ++++++++ >> 1 file changed, 8 insertions(+) >> create mode 100644 .github/PULL_REQUEST_TEMPLATE.md >> >> diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md >> new file mode 100644 >> index 0000000..d0cfd7f >> --- /dev/null >> +++ b/.github/PULL_REQUEST_TEMPLATE.md >> @@ -0,0 +1,8 @@ >> +# Thank you for your contribution >> + >> +You are welcome to open PR, but they are used for discussion only. All >> +patches must eventually go to the openvpn-devel mailing list for review. >> +For details, see these Wiki articles: >> + >> +* https://community.openvpn.net/openvpn/wiki/Contributing <https://community.openvpn.net/openvpn/wiki/Contributing> >> +* https://community.openvpn.net/openvpn/wiki/DeveloperDocumentation <https://community.openvpn.net/openvpn/wiki/DeveloperDocumentation> >> > > Based on testing in the travis-openssl-test repository the template > works as intended, so ACK on that part. > > Any comments on the text itself? How does this work with branches? Do we need to say that new patches should go into the master branch primarily, unless it is fixing a bug or another issue which is only relevant for specific release branches? we can put such information to https://community.openvpn.net/openvpn/wiki/Contributing <https://community.openvpn.net/openvpn/wiki/Contributing> https://community.openvpn.net/openvpn/wiki/DeveloperDocumentation <https://community.openvpn.net/openvpn/wiki/DeveloperDocumentation> I would leave PR template skinny -- kind regards, David Sommerseth OpenVPN Technologies, Inc
Signature · 5 lines
Samuli Seppänen Community Manager OpenVPN Technologies, Inc irc freenode net: mattock
Quoted 4 lines · Samuli Seppänen
I agree with you on keeping the pull request template minimal and having the more fine-grained information in Trac.
ACK.
Don't get me wrong! I agree we should keep the template minimal. But I yet have to see a developer full of enthusiasm with a fix ready, who just clicked "Send pull request!" who will actually instantly go reading further. And especially when the information need is fairly comprehensive and not even directly in the first URL being listed.
In fact the first place where the patch process is described is here:
<https://community.openvpn.net/openvpn/wiki/DeveloperDocumentation#Communitypatchesandtheacceptanceprocessofthesepatches>.
That is "hidden" in the middle of the wiki on the second URL. And the
first URL provides just a link to the same DeveloperDocumentation wiki page.
So I kindly ask you to reconsider the text more carefully once more.
2017-01-31 18:49 GMT+05:00 David Sommerseth <
[email protected]...>:
Quoted 12 lines · Samuli Seppänen
Quoted 4 lines
I agree with you on keeping the pull request template minimal and having the more fine-grained information in Trac.
ACK.
Don't get me wrong! I agree we should keep the template minimal. But I yet have to see a developer full of enthusiasm with a fix ready, who just clicked "Send pull request!" who will actually instantly go reading further. And especially when the information need is fairly comprehensive and not even directly in the first URL being listed.
Quoted 9 lines
In fact the first place where the patch process is described is here:
<https://community.openvpn.net/openvpn/wiki/DeveloperDocumentation#
Communitypatchesandtheacceptanceprocessofthesepatches>.
That is "hidden" in the middle of the wiki on the second URL. And the
first URL provides just a link to the same DeveloperDocumentation wiki page.So I kindly ask you to reconsider the text more carefully once more.
well, I double checked everything, including refrigerator, unfortunately, current text is the best I have.
@mattock, do you have a better text ?
Quoted 106 lines
From my experience, to get the best success, provide the most critical and as accurate information as quickly as possible. Once things are behind one URL you need to visit, many ignores it. If you need to read through more text on that URL, even more will fall off. But provide links to the more verbose documentation, as some will read it if the first 2-3 sentences sounds intriguing and the contributor have time to be curious.
Most developers are lazy beasts ... they just want their patches out ASAP, and documentation are too easily ignored.
--
kind regards,David Sommerseth
OpenVPN Technologies, IncQuoted 13 lines · Илья Шипицин
Quoted 12 lines
can we merge it ?
@mattock ?2017-01-21 13:47 GMT+05:00 Илья Шипицин <[email protected]... <mailto:[email protected]...>>:
2017-01-21 0:24 GMT+05:00 David Sommerseth <[email protected]... <mailto:[email protected]...>>:Quoted 8 lines
Quoted 8 lines · Samuli Seppänen
> Il 13/01/2017 10:50, Ilya Shipitsin ha scritto: >> --- >> .github/PULL_REQUEST_TEMPLATE.md | 8 ++++++++ >> 1 file changed, 8 insertions(+) >> create mode 100644 .github/PULL_REQUEST_TEMPLATE.md >> >> diff --git a/.github/PULL_REQUEST_TEMPLATE.md
b/.github/PULL_REQUEST_TEMPLATE.mdQuoted 8 lines
Quoted 8 lines
>> new file mode 100644 >> index 0000000..d0cfd7f >> --- /dev/null >> +++ b/.github/PULL_REQUEST_TEMPLATE.md >> @@ -0,0 +1,8 @@ >> +# Thank you for your contribution >> + >> +You are welcome to open PR, but they are used fordiscussion only. All
Quoted 1 line
Quoted 1 line
>> +patches must eventually go to the openvpn-devel mailing
list for review.
Quoted 5 lines
Quoted 5 lines
>> +For details, see these Wiki articles:
>> +
>> +* https://community.openvpn.net/openvpn/wiki/Contributing
<https://community.openvpn.net/openvpn/wiki/Contributing>
>> +* https://community.openvpn.net/openvpn/wiki/DeveloperDocumentation <https://community.openvpn.net/openvpn/wiki/
DeveloperDocumentation>Quoted 3 lines
Quoted 3 lines
>> > > Based on testing in the travis-openssl-test repository thetemplate
Quoted 9 lines
Quoted 9 lines
> works as intended, so ACK on that part.
>
> Any comments on the text itself?How does this work with branches? Do we need to say that new patches
should go into the master branch primarily, unless it is fixing a bug or
another issue which is only relevant for specific releasebranches?
Quoted 27 lines
Quoted 25 lines
we can put such information to
https://community.openvpn.net/openvpn/wiki/Contributing
<https://community.openvpn.net/openvpn/wiki/Contributing>
https://community.openvpn.net/openvpn/wiki/DeveloperDocumentation
<https://community.openvpn.net/openvpn/wiki/DeveloperDocumentation>I would leave PR template skinny
--
kind regards,David Sommerseth
OpenVPN Technologies, Inc
Quoted 27 lines · David Sommerseth
Quoted 4 lines · Samuli Seppänen
I agree with you on keeping the pull request template minimal and having the more fine-grained information in Trac.
ACK.
Don't get me wrong! I agree we should keep the template minimal. But I yet have to see a developer full of enthusiasm with a fix ready, who just clicked "Send pull request!" who will actually instantly go reading further. And especially when the information need is fairly comprehensive and not even directly in the first URL being listed.
In fact the first place where the patch process is described is here:
<https://community.openvpn.net/openvpn/wiki/DeveloperDocumentation#Communitypatchesandtheacceptanceprocessofthesepatches>.
That is "hidden" in the middle of the wiki on the second URL. And the
first URL provides just a link to the same DeveloperDocumentation wiki page.So I kindly ask you to reconsider the text more carefully once more.
From my experience, to get the best success, provide the most critical and as accurate information as quickly as possible. Once things are behind one URL you need to visit, many ignores it. If you need to read through more text on that URL, even more will fall off. But provide links to the more verbose documentation, as some will read it if the first 2-3 sentences sounds intriguing and the contributor have time to be curious.
Quoted 4 lines
Most developers are lazy beasts ... they just want their patches out ASAP, and documentation are too easily ignored.
Well, I asked if anyone had any comments regarding the PR template text, and nobody did. Except when it was ACKed, of course :).
I think we need to lure GitHub people into sending patches to the mailing list. If we describe the full process in the pull request template, many will just say "meh, too difficult". Once they've sent their patch to the list they're quite far already, and are unlikely to quit if we ask them to make minor changes.
So what about this:
---
# Thank you for your contribution
You are welcome to open PR, but they are used for discussion only. All patches must eventually go to the openvpn-devel mailing list for review:
* https://lists.sourceforge.net/lists/listinfo/openvpn-devel
Please send your patch using [git-send-email](https://git-scm.com/docs/git-send-email). For example to send your latest commit to the list:
$ git-send-email [email protected] HEAD~1
For details, see these Wiki articles:
* https://community.openvpn.net/openvpn/wiki/Contributing
* https://community.openvpn.net/openvpn/wiki/DeveloperDocumentation
---
Signature · 5 lines
Samuli Seppänen Community Manager OpenVPN Technologies, Inc irc freenode net: mattock
2017-02-02 13:27 GMT+05:00 Samuli Seppänen <[email protected]...>:
Quoted 56 lines · David Sommerseth
Quoted 32 lines · Samuli Seppänen
Quoted 6 lines
I agree with you on keeping the pull request template minimal and having the more fine-grained information in Trac.
ACK.
Don't get me wrong! I agree we should keep the template minimal. But I yet have to see a developer full of enthusiasm with a fix ready, who just clicked "Send pull request!" who will actually instantly go reading further. And especially when the information need is fairly comprehensive and not even directly in the first URL being listed.
In fact the first place where the patch process is described is here:
<https://community.openvpn.net/openvpn/wiki/DeveloperDocumen
tation#Communitypatchesandtheacceptanceprocessofthesepatches>.
That is "hidden" in the middle of the wiki on the second URL. And the
first URL provides just a link to the same DeveloperDocumentation wiki page.So I kindly ask you to reconsider the text more carefully once more.
From my experience, to get the best success, provide the most critical and as accurate information as quickly as possible. Once things are behind one URL you need to visit, many ignores it. If you need to read through more text on that URL, even more will fall off. But provide links to the more verbose documentation, as some will read it if the first 2-3 sentences sounds intriguing and the contributor have time to be curious.
Quoted 5 lines
Most developers are lazy beasts ... they just want their patches out ASAP, and documentation are too easily ignored.
Well, I asked if anyone had any comments regarding the PR template text, and nobody did. Except when it was ACKed, of course :).
I think we need to lure GitHub people into sending patches to the mailing list. If we describe the full process in the pull request template, many will just say "meh, too difficult". Once they've sent their patch to the list they're quite far already, and are unlikely to quit if we ask them to make minor changes.
So what about this:
---
# Thank you for your contribution
You are welcome to open PR, but they are used for discussion only. All patches must eventually go to the openvpn-devel mailing list for review:
Quoted 8 lines
* https://lists.sourceforge.net/lists/listinfo/openvpn-devel
Please send your patch using [git-send-email](https://git-s cm.com/docs/git-send-email). For example to send your latest commit to the list:
$ git-send-email [email protected] HEAD~1
documentation seems to be confusing here.
I could not get "git-send-email" for fedora, it is "git send-email" instead. something like "send patches to list" should be ok
Quoted 16 lines
For details, see these Wiki articles:
* https://community.openvpn.net/openvpn/wiki/Contributing
* https://community.openvpn.net/openvpn/wiki/DeveloperDocumentation---
--
Samuli Seppänen
Community Manager
OpenVPN Technologies, Incirc freenode net: mattock
Quoted 9 lines · Илья Шипицин
Quoted 6 lines
Please send your patch using [git-send-email](https://git-s cm.com/docs/git-send-email). For example to send your latest commit to the list:
$ git-send-email [email protected] HEAD~1documentation seems to be confusing here.
I could not get "git-send-email" for fedora, it is "git send-email" instead.
I think this was a typ0 from Samuli. It's "git send-email" on every system. Giving an easy way to send patches (with just one command) is probably useful:
avoid several iterations when people try to send their patches with gmail and similar ..
Cheers,
Signature · 1 line
Antonio Quartulli
Quoted 11 lines · Antonio Quartulli
Quoted 9 lines · Илья Шипицин
Quoted 6 lines
Please send your patch using [git-send-email](https://git-s cm.com/docs/git-send-email). For example to send your latest commit to the list:
$ git-send-email [email protected] HEAD~1documentation seems to be confusing here.
I could not get "git-send-email" for fedora, it is "git send-email" instead.
Quoted 6 lines
I think this was a typ0 from Samuli. It's "git send-email" on every system. Giving an easy way to send patches (with just one command) is probably useful:
avoid several iterations when people try to send their patches with gmail and similar ..Cheers,
It was not a typo. I actually did not know about "git send-email" until now. I've used "git-send-email" which on Debian/Ubuntu resides in /usr/lib/git-core. Are these the same thing?
Anyways, let's use "git send-email" in the PR template if that one is readily available on all Git installations.
Signature · 5 lines
Samuli Seppänen Community Manager OpenVPN Technologies, Inc irc freenode net: mattock
Hi,
Quoted 3 lines · Samuli Seppänen
It was not a typo. I actually did not know about "git send-email" until now. I've used "git-send-email" which on Debian/Ubuntu resides in
/usr/lib/git-core. Are these the same thing?
Sort of. When you run "git foo", git will (if it's not a built-in) go out and look for a program "git-foo" in your PATH, or it seems in its libdir.
The "ACK and mail" script David and I use is called "git-ack-am", I put it in $HOME/bin/git-ack-am, and then I can do "git ack-am ..." on patches...
Quoted 2 lines
Anyways, let's use "git send-email" in the PR template if that one is readily available on all Git installations.
That's the official one. The other one is what you call under the hood, and the fact that it's not in "bin/" tells stories :-)
gert
Signature · 4 lines
USENET is *not* the non-clickable part of WWW!
//www.muc.de/~gert/
Gert Doering - Munich, Germany [email protected]...
fax: +49-89-35655025 [email protected]...Quoted 57 lines · Samuli Seppänen
Quoted 27 lines · David Sommerseth
Quoted 4 lines · Samuli Seppänen
I agree with you on keeping the pull request template minimal and having the more fine-grained information in Trac.
ACK.
Don't get me wrong! I agree we should keep the template minimal. But I yet have to see a developer full of enthusiasm with a fix ready, who just clicked "Send pull request!" who will actually instantly go reading further. And especially when the information need is fairly comprehensive and not even directly in the first URL being listed.
In fact the first place where the patch process is described is here:
<https://community.openvpn.net/openvpn/wiki/DeveloperDocumentation#Communitypatchesandtheacceptanceprocessofthesepatches>.
That is "hidden" in the middle of the wiki on the second URL. And the
first URL provides just a link to the same DeveloperDocumentation wiki page.So I kindly ask you to reconsider the text more carefully once more.
From my experience, to get the best success, provide the most critical and as accurate information as quickly as possible. Once things are behind one URL you need to visit, many ignores it. If you need to read through more text on that URL, even more will fall off. But provide links to the more verbose documentation, as some will read it if the first 2-3 sentences sounds intriguing and the contributor have time to be curious.
Quoted 4 lines
Most developers are lazy beasts ... they just want their patches out ASAP, and documentation are too easily ignored.
Well, I asked if anyone had any comments regarding the PR template text, and nobody did. Except when it was ACKed, of course :).
I think we need to lure GitHub people into sending patches to the mailing list. If we describe the full process in the pull request template, many will just say "meh, too difficult". Once they've sent their patch to the list they're quite far already, and are unlikely to quit if we ask them to make minor changes.
So what about this:
---
# Thank you for your contribution
You are welcome to open PR, but they are used for discussion only. All patches must eventually go to the openvpn-devel mailing list for review:
* https://lists.sourceforge.net/lists/listinfo/openvpn-devel
Please send your patch using [git-send-email](https://git-scm.com/docs/git-send-email). For example to send your latest commit to the list:
Quoted 6 lines
$ git-send-email [email protected] HEAD~1For details, see these Wiki articles:
* https://community.openvpn.net/openvpn/wiki/Contributing
* https://community.openvpn.net/openvpn/wiki/DeveloperDocumentation
Thank you! Much better!
I would just change the order of the URLs below, the Contributing one is very generic and not very developer specific. The second one got the core development contribution details.
For the git-send-email/git send-email ... Antonio and Gert have already covered that (both are correct).
Signature · 4 lines
kind regards, David Sommerseth OpenVPN Technologies, Inc