www.digitalmars.com         C & C++   DMDScript  

digitalmars.D - Pull request names

reply "Steven Schveighoffer" <schveiguy yahoo.com> writes:
To all who are generating pull requests:

I get emails for every pull request message that is posted, as do anyone  
who is subscribed to the github project.

A recent message in my email:



Re: [phobos] Fix issue 12419 (#2038)

 monarchdodra Good point, done.

-
Reply to this email directly or view it on GitHub.




The "view it on Github" is a link to the message. So I can see what this  
is about. But it would be nice if the pull request title was more  
descriptive. I don't know what issue 12419 is.

Please note, I am not complaining about the volume of pull request  
chatter, this is great! But the title of the pull request should describe  
what it logically is without having to click through to a bug report or  
read everything about the pull request.

If you want to say "fix issue XXX", please repeat the bug title at least.

-Steve
Mar 24 2014
next sibling parent reply Andrej Mitrovic <andrej.mitrovich gmail.com> writes:
On 3/24/14, Steven Schveighoffer <schveiguy yahoo.com> wrote:
 To all who are generating pull requests.

I keep saying the same thing to pull makers. When I'm not too busy I also rename their pull request to add the title description. Another thing I keep mentioning is to add a link to the bugzilla issue in the pull request.
Mar 24 2014
parent Walter Bright <newshound2 digitalmars.com> writes:
On 3/24/2014 12:47 PM, Andrej Mitrovic wrote:
 On 3/24/14, Steven Schveighoffer <schveiguy yahoo.com> wrote:
 To all who are generating pull requests.

I keep saying the same thing to pull makers. When I'm not too busy I also rename their pull request to add the title description. Another thing I keep mentioning is to add a link to the bugzilla issue in the pull request.

Yes, indeed. I think it's just polite to include a link to the bugzilla issue as well as a link in the bugzilla issue back to the PR.
Mar 24 2014
prev sibling next sibling parent "Daniel Murphy" <yebbliesnospam gmail.com> writes:
"Steven Schveighoffer"  wrote in message 
news:op.xc8mg5laeav7ka stevens-macbook-pro.local...

 The "view it on Github" is a link to the message. So I can see what this 
 is about. But it would be nice if the pull request title was more 
 descriptive. I don't know what issue 12419 is.

It does say this in the wiki: http://wiki.dlang.org/Pull_Requests#Create_a_pull_request Don't forget you can edit the titles of other people's pull requests!
Mar 24 2014
prev sibling next sibling parent "Jakob Ovrum" <jakobovrum gmail.com> writes:
On Monday, 24 March 2014 at 17:49:43 UTC, Steven Schveighoffer 
wrote:
 To all who are generating pull requests:

 I get emails for every pull request message that is posted, as 
 do anyone who is subscribed to the github project.

Though I agree with everything you said, it is possible to "watch" a repository without receiving email notifications, for those who are fine with just the web interface's notification system.
Mar 24 2014
prev sibling next sibling parent reply "monarch_dodra" <monarchdodra gmail.com> writes:
On Monday, 24 March 2014 at 17:49:43 UTC, Steven Schveighoffer 
wrote:
 If you want to say "fix issue XXX", please repeat the bug title 
 at least.

 -Steve

Yeah, that does get on my nerves sometimes too. But I do nothing about it, so I'm not part of the solution. I guess I should now. Also, when fixing an issue, *please* provide a link to said issue. Searching for "XXX" in the bug repo myself is un-necessary overhead.
Mar 24 2014
parent Walter Bright <newshound2 digitalmars.com> writes:
On 3/24/2014 11:58 PM, Vladimir Panteleev wrote:
 Tip: go to Bugzilla, right-click the "Search" field at the top, and select
 "Create search". Assign a keyboard (e.g. "db" for "D Bugs"), and then you can
go
 to any issue by typing "db NNNNN" in the address bar (or search Bugzilla by
 entering search terms instead of NNNNN).

I do it an even easier way. I go to a bugzilla issue from my browser history, then edit the address with a new NNNNN :-)
Mar 25 2014
prev sibling next sibling parent "Vladimir Panteleev" <vladimir thecybershadow.net> writes:
On Tuesday, 25 March 2014 at 06:45:30 UTC, monarch_dodra wrote:
 On Monday, 24 March 2014 at 17:49:43 UTC, Steven Schveighoffer 
 wrote:
 If you want to say "fix issue XXX", please repeat the bug 
 title at least.

 -Steve

Yeah, that does get on my nerves sometimes too. But I do nothing about it, so I'm not part of the solution. I guess I should now. Also, when fixing an issue, *please* provide a link to said issue. Searching for "XXX" in the bug repo myself is un-necessary overhead.

Tip: go to Bugzilla, right-click the "Search" field at the top, and select "Create search". Assign a keyboard (e.g. "db" for "D Bugs"), and then you can go to any issue by typing "db NNNNN" in the address bar (or search Bugzilla by entering search terms instead of NNNNN).
Mar 24 2014
prev sibling next sibling parent "w0rp" <devw0rp gmail.com> writes:
On Monday, 24 March 2014 at 17:49:43 UTC, Steven Schveighoffer 
wrote:
 To all who are generating pull requests:

 I get emails for every pull request message that is posted, as 
 do anyone who is subscribed to the github project.

 A recent message in my email:



 Re: [phobos] Fix issue 12419 (#2038)

  monarchdodra Good point, done.

 -
 Reply to this email directly or view it on GitHub.




 The "view it on Github" is a link to the message. So I can see 
 what this is about. But it would be nice if the pull request 
 title was more descriptive. I don't know what issue 12419 is.

 Please note, I am not complaining about the volume of pull 
 request chatter, this is great! But the title of the pull 
 request should describe what it logically is without having to 
 click through to a bug report or read everything about the pull 
 request.

 If you want to say "fix issue XXX", please repeat the bug title 
 at least.

 -Steve

I know exactly what you are talking about. I had this same issue with git at one of my previous jobs. We used to have commit messages that were tied to tickets, and we'd have messages like, "Fix so and so." So I started using the convention "#1234 - Fix so and so." So my coworkers noticed this, thought referencing the bug was a good idea and switched... only to writing the bug number in the commit message and nothing else. So 'git log' read kind of like this. Bob - "#347" Joe - "#346" Me - "#345 - Fix a rendering bug with this thing on this machine." Bob - "#228" It was really frustrating.
Mar 25 2014
prev sibling next sibling parent "monarch_dodra" <monarchdodra gmail.com> writes:
On Tuesday, 25 March 2014 at 06:58:53 UTC, Vladimir Panteleev 
wrote:
 Tip: go to Bugzilla, right-click the "Search" field at the top, 
 and select "Create search". Assign a keyboard (e.g. "db" for "D 
 Bugs"), and then you can go to any issue by typing "db NNNNN" 
 in the address bar (or search Bugzilla by entering search terms 
 instead of NNNNN).

On Tuesday, 25 March 2014 at 07:03:24 UTC, Walter Bright wrote:
 I do it an even easier way. I go to a bugzilla issue from my 
 browser history, then edit the address with a new NNNNN :-)

Good tips (Walter, I mostly use your strategy), but still something I shouldn't have to put up with. I'd simply call it common decency to link whatever you are talking to...
Mar 25 2014
prev sibling next sibling parent Brad Roberts <braddr puremagic.com> writes:
On 3/25/14, 1:08 AM, w0rp wrote:
 On Monday, 24 March 2014 at 17:49:43 UTC, Steven Schveighoffer wrote:
 To all who are generating pull requests:

 I get emails for every pull request message that is posted, as do anyone who
is subscribed to the
 github project.

 A recent message in my email:



 Re: [phobos] Fix issue 12419 (#2038)

  monarchdodra Good point, done.

 -
 Reply to this email directly or view it on GitHub.




 The "view it on Github" is a link to the message. So I can see what this is
about. But it would be
 nice if the pull request title was more descriptive. I don't know what issue
12419 is.

 Please note, I am not complaining about the volume of pull request chatter,
this is great! But the
 title of the pull request should describe what it logically is without having
to click through to
 a bug report or read everything about the pull request.

 If you want to say "fix issue XXX", please repeat the bug title at least.

 -Steve

I know exactly what you are talking about. I had this same issue with git at one of my previous jobs. We used to have commit messages that were tied to tickets, and we'd have messages like, "Fix so and so." So I started using the convention "#1234 - Fix so and so." So my coworkers noticed this, thought referencing the bug was a good idea and switched... only to writing the bug number in the commit message and nothing else. So 'git log' read kind of like this. Bob - "#347" Joe - "#346" Me - "#345 - Fix a rendering bug with this thing on this machine." Bob - "#228" It was really frustrating.

Sounds like there's considerable agreement (including me). So.. make sure pull requests have the appropriate info. If one doesn't, prompt the requester to include it. If there's wiki nodes out there that describe the pull request process, make sure it includes appropriate instructions. Etc. This is a very easy to solve issue.. just some habits to be (re-)formed.
Mar 25 2014
prev sibling next sibling parent "Rikki Cattermole" <alphaglosined gmail.com> writes:
On Monday, 24 March 2014 at 17:49:43 UTC, Steven Schveighoffer 
wrote:
 To all who are generating pull requests:

 I get emails for every pull request message that is posted, as 
 do anyone who is subscribed to the github project.

 A recent message in my email:



 Re: [phobos] Fix issue 12419 (#2038)

  monarchdodra Good point, done.

 -
 Reply to this email directly or view it on GitHub.




 The "view it on Github" is a link to the message. So I can see 
 what this is about. But it would be nice if the pull request 
 title was more descriptive. I don't know what issue 12419 is.

 Please note, I am not complaining about the volume of pull 
 request chatter, this is great! But the title of the pull 
 request should describe what it logically is without having to 
 click through to a bug report or read everything about the pull 
 request.

 If you want to say "fix issue XXX", please repeat the bug title 
 at least.

 -Steve

I wonder if we can get github to add support to linking our bugzilla tickets against #<num> like they do with the built in tracker. Unless it already has it?
Mar 25 2014
prev sibling next sibling parent "Vladimir Panteleev" <vladimir thecybershadow.net> writes:
On Tuesday, 25 March 2014 at 08:38:32 UTC, Rikki Cattermole wrote:
 On Monday, 24 March 2014 at 17:49:43 UTC, Steven Schveighoffer 
 wrote:
 To all who are generating pull requests:

 I get emails for every pull request message that is posted, as 
 do anyone who is subscribed to the github project.

 A recent message in my email:



 Re: [phobos] Fix issue 12419 (#2038)

  monarchdodra Good point, done.

 -
 Reply to this email directly or view it on GitHub.




 The "view it on Github" is a link to the message. So I can see 
 what this is about. But it would be nice if the pull request 
 title was more descriptive. I don't know what issue 12419 is.

 Please note, I am not complaining about the volume of pull 
 request chatter, this is great! But the title of the pull 
 request should describe what it logically is without having to 
 click through to a bug report or read everything about the 
 pull request.

 If you want to say "fix issue XXX", please repeat the bug 
 title at least.

 -Steve

I wonder if we can get github to add support to linking our bugzilla tickets against #<num> like they do with the built in tracker. Unless it already has it?

I made this userscript a few years ago, when D development was moved to GitHub: http://dump.thecybershadow.net/b7d2e2759116df7a83ee2f4678856a1e/dbuglinks.user.js It acts on the "issue NNNN" pattern, because the "#NNNN" pattern is already used by GitHub to link to its issues / pull requests.
Mar 25 2014
prev sibling next sibling parent Andrej Mitrovic <andrej.mitrovich gmail.com> writes:
On 3/25/14, Vladimir Panteleev <vladimir thecybershadow.net> wrote:
 Tip: go to Bugzilla, right-click the "Search" field at the top,
 and select "Create search". Assign a keyboard (e.g. "db" for "D
 Bugs"), and then you can go to any issue by typing "db NNNNN" in
 the address bar (or search Bugzilla by entering search terms
 instead of NNNNN).

Ah nice. Could you dwiki this? Thanks!
Mar 25 2014
prev sibling next sibling parent "Vladimir Panteleev" <vladimir thecybershadow.net> writes:
On Tuesday, 25 March 2014 at 10:36:15 UTC, Andrej Mitrovic wrote:
 On 3/25/14, Vladimir Panteleev <vladimir thecybershadow.net> 
 wrote:
 Tip: go to Bugzilla, right-click the "Search" field at the top,
 and select "Create search". Assign a keyboard (e.g. "db" for "D
 Bugs"), and then you can go to any issue by typing "db NNNNN" 
 in
 the address bar (or search Bugzilla by entering search terms
 instead of NNNNN).

Ah nice. Could you dwiki this? Thanks!

http://wiki.dlang.org/Bugzilla
Mar 25 2014
prev sibling next sibling parent Andrej Mitrovic <andrej.mitrovich gmail.com> writes:
On 3/25/14, Vladimir Panteleev <vladimir thecybershadow.net> wrote:
 On Tuesday, 25 March 2014 at 10:36:15 UTC, Andrej Mitrovic wrote:
 On 3/25/14, Vladimir Panteleev <vladimir thecybershadow.net>
 wrote:
 Tip: go to Bugzilla, right-click the "Search" field at the top,
 and select "Create search". Assign a keyboard (e.g. "db" for "D
 Bugs"), and then you can go to any issue by typing "db NNNNN"
 in
 the address bar (or search Bugzilla by entering search terms
 instead of NNNNN).

Ah nice. Could you dwiki this? Thanks!

http://wiki.dlang.org/Bugzilla

Thanks again.
Mar 25 2014
prev sibling parent "Steven Schveighoffer" <schveiguy yahoo.com> writes:
On Mon, 24 Mar 2014 23:16:57 -0400, Jakob Ovrum <jakobovrum gmail.com>  
wrote:

 On Monday, 24 March 2014 at 17:49:43 UTC, Steven Schveighoffer wrote:
 To all who are generating pull requests:

 I get emails for every pull request message that is posted, as do  
 anyone who is subscribed to the github project.

Though I agree with everything you said, it is possible to "watch" a repository without receiving email notifications, for those who are fine with just the web interface's notification system.

It's not the notifications I dislike, I actually like emails much better than dealing with the interface, I can delete ones I'm not going to look at. It's the requirement to click through to find out what the email is about. Might as well get an email that says "Something changed" :) I see that anyone can change the pull request title. That is a good solution, let's anyone who sees such a pull request notify the author of the requirement to be more descriptive, and change it when we see it. Thanks! -Steve
Mar 25 2014