March 25, 2014 Re: Pull request names | ||||
---|---|---|---|---|
| ||||
Posted in reply to w0rp | 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.
|
March 25, 2014 Re: Pull request names | ||||
---|---|---|---|---|
| ||||
Posted in reply to Steven Schveighoffer | 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?
|
March 25, 2014 Re: Pull request names | ||||
---|---|---|---|---|
| ||||
Posted in reply to Rikki Cattermole | 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. |
March 25, 2014 Re: Pull request names | ||||
---|---|---|---|---|
| ||||
Posted in reply to Vladimir Panteleev | 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!
|
March 25, 2014 Re: Pull request names | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrej Mitrovic | 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 |
March 25, 2014 Re: Pull request names | ||||
---|---|---|---|---|
| ||||
Posted in reply to Vladimir Panteleev | 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.
|
March 25, 2014 Re: Pull request names | ||||
---|---|---|---|---|
| ||||
Posted in reply to Jakob Ovrum | 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
|
Copyright © 1999-2021 by the D Language Foundation