12:43 a.m.
Hey,
I'm seeing a tendency to just put the JIRA number + possible merge info in the topic
of the pullrequest and git commit messages are long lines of text instead of properly
formatted.
This makes it rather hard to look at the list of PR and git history and figure out what
they are about plus they duplicate the merge info Github already knows about.
You might not be aware that git actually uses some rules/conventions on the git messages
to make things like git log be readable and informative, git rebase and squash etc. can
use the titles better and finally github uses the same conventions for their pull
requests.
Thus if you treat the github pullrequest similar to how a good git commit comment is done
(you can even copy/paste them if there is a 1-to-1 match) then we should be good.
Thus the basic conventions are:
1 line for title, max 50 characters and don't end with a '.'
Two new lines
paragraph of text, max 72 characters wide containing the necessary info/details.
And that 1 line title for our workflow is best started with the jira ID.
Thus a good minimal commit message would look like this:
JBIDE-1234 - hibernate tools 4 classloading is broken.
Because of changes in Hibernate 4 classloader we can no longer
do XYZ. Thus I've made it do ZXY instead.
For a PR you can either just copy verbatim the above or maybe add some refs/details:
JBIDE-1234 - hibernate tools 4 classloading is broken.
This should be applied not only to master but also branch jbosstools-4.0.x
With this github dashboard and git log messages becomes much more informative.
Links with more background/tips with respect to commits/messages/workflows:
http://who-t.blogspot.cz/2009/12/on-commit-messages.html
http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
/max
2:38 a.m.
On 21. 11. 2012, at 7:43, Max Rydahl Andersen <max.andersen(a)redhat.com> wrote:
1 line for title, max 50 characters and don't end with a '.'
JBIDE-1234 - hibernate tools 4 classloading is broken.
;)
Anyway, thanks for the suggestions. I usually don't use '-', but that
shouldn't matter, right? Also, I never used newlines in the long description and now I
see that it's not good - git log now displays one long line :( So breaking the lines
manually is a good idea.
-Martin
10:29 a.m.
>
> 1 line for title, max 50 characters and don't end with a '.'
>
> JBIDE-1234 - hibernate tools 4 classloading is broken.
>
;)
Anyway, thanks for the suggestions. I usually don't use '-', but that
shouldn't matter, right?
No, it doesn't matter.
Also, I never used newlines in the long description and now I see
that it's not good - git log now displays one long line :( So breaking the lines
manually is a good idea.
Yes, its normal coming from svn, where looking at history is/was painful so rarely
noticed.
but in git you do it all the time and the tools assumes this style and gives much better
experience when using the newline.
/max
11 a.m.
On 11/21/2012 08:29 AM, Max Rydahl Andersen wrote:
>> 1 line for title, max 50 characters and don't end with a
'.'
>>
>> JBIDE-1234 - hibernate tools 4 classloading is broken.
>>
> ;)
>
> Anyway, thanks for the suggestions. I usually don't use '-', but that
shouldn't matter, right?
No, it doesn't matter.
Full link would be shown as a link in on github, but I guess with
limitation of 50 chars that is not really possible to use.
Denis
> Also, I never used newlines in the long description and now I see that it's not
good - git log now displays one long line :( So breaking the lines manually is a good
idea.
Yes, its normal coming from svn, where looking at history is/was painful so rarely
noticed.
but in git you do it all the time and the tools assumes this style and gives much better
experience when using the newline.
/max
_______________________________________________
jbosstools-dev mailing list
jbosstools-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/jbosstools-dev
11:25 a.m.
>> Anyway, thanks for the suggestions. I usually don't use
'-', but that shouldn't matter, right?
> No, it doesn't matter.
Full link would be shown as a link in on github, but I guess with limitation of 50 chars
that is not really possible to use.
full links are rather useless and noisy.
My workaround for that is to install greasemonkey script that autolinks JBIDE-xyz to
jira.
Tampermonkey with Autolink works for me - i'll try and zip up what I got and post it
as soon as possible.
/max
11:48 a.m.
even simpler... if using FF, set up a bookmark like this:
location: https://jira.jboss.org/jira/browse/JBIDE-%s
keyword: jbide
Then...
double-click the JIRA number anywhere in a browser page. CTRL-C, CTRL-T,
jbide (space) CTRL-V, enter.
Result - 9 keystrokes to get here:
https://issues.jboss.org/browse/JBIDE-12345
On 11/21/2012 12:25 PM, Max Rydahl Andersen wrote:
>>> Anyway, thanks for the suggestions. I usually don't
use '-', but that shouldn't matter, right?
>> No, it doesn't matter.
>
> Full link would be shown as a link in on github, but I guess with limitation of 50
chars that is not really possible to use.
full links are rather useless and noisy.
My workaround for that is to install greasemonkey script that autolinks JBIDE-xyz to
jira.
Tampermonkey with Autolink works for me - i'll try and zip up what I got and post it
as soon as possible.
/max
_______________________________________________
jbosstools-dev mailing list
jbosstools-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/jbosstools-dev
--
Nick Boldt :: JBoss by Red Hat
Productization Lead :: JBoss Tools & Dev Studio
http://nick.divbyzero.com
12:25 p.m.
How do 9 keystrokes beat 1 click (using the greasmonkey script)?
Le 21/11/2012 18:48, Nick Boldt a écrit :
even simpler... if using FF, set up a bookmark like this:
location: https://jira.jboss.org/jira/browse/JBIDE-%s
keyword: jbide
Then...
double-click the JIRA number anywhere in a browser page. CTRL-C, CTRL-T,
jbide (space) CTRL-V, enter.
Result - 9 keystrokes to get here:
https://issues.jboss.org/browse/JBIDE-12345
On 11/21/2012 12:25 PM, Max Rydahl Andersen wrote:
>>>> Anyway, thanks for the suggestions. I usually don't use '-',
but that shouldn't matter, right?
>>> No, it doesn't matter.
>> Full link would be shown as a link in on github, but I guess with limitation of
50 chars that is not really possible to use.
> full links are rather useless and noisy.
>
> My workaround for that is to install greasemonkey script that autolinks JBIDE-xyz to
jira.
>
> Tampermonkey with Autolink works for me - i'll try and zip up what I got and post
it as soon as possible.
>
> /max
>
>
> _______________________________________________
> jbosstools-dev mailing list
> jbosstools-dev(a)lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/jbosstools-dev
>
1:32 p.m.
because you don't have to install extra javascript-heavy stuff that
slows down firefox? (It's been a while since I used greasemonkey but I
remember it causing FF to grind down and sometimes halt.)
N
On 11/21/2012 01:25 PM, Fred Bricon wrote:
How do 9 keystrokes beat 1 click (using the greasmonkey script)?
Le 21/11/2012 18:48, Nick Boldt a �crit :
> even simpler... if using FF, set up a bookmark like this:
>
> location: https://jira.jboss.org/jira/browse/JBIDE-%s
> keyword: jbide
>
> Then...
>
> double-click the JIRA number anywhere in a browser page. CTRL-C, CTRL-T,
> jbide (space) CTRL-V, enter.
>
> Result - 9 keystrokes to get here:
>
> https://issues.jboss.org/browse/JBIDE-12345
>
>
>
> On 11/21/2012 12:25 PM, Max Rydahl Andersen wrote:
>>>>> Anyway, thanks for the suggestions. I usually don't use
'-', but
>>>>> that shouldn't matter, right?
>>>> No, it doesn't matter.
>>> Full link would be shown as a link in on github, but I guess with
>>> limitation of 50 chars that is not really possible to use.
>> full links are rather useless and noisy.
>>
>> My workaround for that is to install greasemonkey script that
>> autolinks JBIDE-xyz to jira.
>>
>> Tampermonkey with Autolink works for me - i'll try and zip up what I
>> got and post it as soon as possible.
>>
>> /max
>>
>>
>> _______________________________________________
>> jbosstools-dev mailing list
>> jbosstools-dev(a)lists.jboss.org
>> https://lists.jboss.org/mailman/listinfo/jbosstools-dev
>>
--
Nick Boldt :: JBoss by Red Hat
Productization Lead :: JBoss Tools & Dev Studio
http://nick.divbyzero.com
12:18 a.m.
because you don't have to install extra javascript-heavy stuff
that slows down firefox? (It's been a while since I used greasemonkey but I remember
it causing FF to grind down and sometimes halt.)
Try it out - use chrome - its not bogged down my system at all.
You can even limit it to only be for github pages if you want to.
/max
N
On 11/21/2012 01:25 PM, Fred Bricon wrote:
> How do 9 keystrokes beat 1 click (using the greasmonkey script)?
>
> Le 21/11/2012 18:48, Nick Boldt a �crit :
>> even simpler... if using FF, set up a bookmark like this:
>>
>> location: https://jira.jboss.org/jira/browse/JBIDE-%s
>> keyword: jbide
>>
>> Then...
>>
>> double-click the JIRA number anywhere in a browser page. CTRL-C, CTRL-T,
>> jbide (space) CTRL-V, enter.
>>
>> Result - 9 keystrokes to get here:
>>
>> https://issues.jboss.org/browse/JBIDE-12345
>>
>>
>>
>> On 11/21/2012 12:25 PM, Max Rydahl Andersen wrote:
>>>>>> Anyway, thanks for the suggestions. I usually don't use
'-', but
>>>>>> that shouldn't matter, right?
>>>>> No, it doesn't matter.
>>>> Full link would be shown as a link in on github, but I guess with
>>>> limitation of 50 chars that is not really possible to use.
>>> full links are rather useless and noisy.
>>>
>>> My workaround for that is to install greasemonkey script that
>>> autolinks JBIDE-xyz to jira.
>>>
>>> Tampermonkey with Autolink works for me - i'll try and zip up what I
>>> got and post it as soon as possible.
>>>
>>> /max
>>>
>>>
>>> _______________________________________________
>>> jbosstools-dev mailing list
>>> jbosstools-dev(a)lists.jboss.org
>>> https://lists.jboss.org/mailman/listinfo/jbosstools-dev
>>>
>
--
Nick Boldt :: JBoss by Red Hat
Productization Lead :: JBoss Tools & Dev Studio
http://nick.divbyzero.com
2:26 a.m.
You can also google the issue number ;-)
(but still, it's more clicks than greasemonkey scripts)
/Xavier
On Nov 22, 2012, at 7:18 AM, Max Rydahl Andersen wrote:
> because you don't have to install extra javascript-heavy
stuff that slows down firefox? (It's been a while since I used greasemonkey but I
remember it causing FF to grind down and sometimes halt.)
Try it out - use chrome - its not bogged down my system at all.
You can even limit it to only be for github pages if you want to.
/max
>
> N
>
> On 11/21/2012 01:25 PM, Fred Bricon wrote:
>> How do 9 keystrokes beat 1 click (using the greasmonkey script)?
>>
>> Le 21/11/2012 18:48, Nick Boldt a �crit :
>>> even simpler... if using FF, set up a bookmark like this:
>>>
>>> location: https://jira.jboss.org/jira/browse/JBIDE-%s
>>> keyword: jbide
>>>
>>> Then...
>>>
>>> double-click the JIRA number anywhere in a browser page. CTRL-C, CTRL-T,
>>> jbide (space) CTRL-V, enter.
>>>
>>> Result - 9 keystrokes to get here:
>>>
>>> https://issues.jboss.org/browse/JBIDE-12345
>>>
>>>
>>>
>>> On 11/21/2012 12:25 PM, Max Rydahl Andersen wrote:
>>>>>>> Anyway, thanks for the suggestions. I usually don't use
'-', but
>>>>>>> that shouldn't matter, right?
>>>>>> No, it doesn't matter.
>>>>> Full link would be shown as a link in on github, but I guess with
>>>>> limitation of 50 chars that is not really possible to use.
>>>> full links are rather useless and noisy.
>>>>
>>>> My workaround for that is to install greasemonkey script that
>>>> autolinks JBIDE-xyz to jira.
>>>>
>>>> Tampermonkey with Autolink works for me - i'll try and zip up what I
>>>> got and post it as soon as possible.
>>>>
>>>> /max
>>>>
>>>>
>>>> _______________________________________________
>>>> jbosstools-dev mailing list
>>>> jbosstools-dev(a)lists.jboss.org
>>>> https://lists.jboss.org/mailman/listinfo/jbosstools-dev
>>>>
>>
>
> --
> Nick Boldt :: JBoss by Red Hat
> Productization Lead :: JBoss Tools & Dev Studio
> http://nick.divbyzero.com
>
>
_______________________________________________
jbosstools-dev mailing list
jbosstools-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/jbosstools-dev
5:22 a.m.
+10000
Le 21/11/2012 07:43, Max Rydahl Andersen a écrit :
Hey,
I'm seeing a tendency to just put the JIRA number + possible merge info in the topic
of the pullrequest and git commit messages are long lines of text instead of properly
formatted.
This makes it rather hard to look at the list of PR and git history and figure out what
they are about plus they duplicate the merge info Github already knows about.
You might not be aware that git actually uses some rules/conventions on the git messages
to make things like git log be readable and informative, git rebase and squash etc. can
use the titles better and finally github uses the same conventions for their pull
requests.
Thus if you treat the github pullrequest similar to how a good git commit comment is done
(you can even copy/paste them if there is a 1-to-1 match) then we should be good.
Thus the basic conventions are:
1 line for title, max 50 characters and don't end with a '.'
Two new lines
paragraph of text, max 72 characters wide containing the necessary info/details.
And that 1 line title for our workflow is best started with the jira ID.
Thus a good minimal commit message would look like this:
JBIDE-1234 - hibernate tools 4 classloading is broken.
Because of changes in Hibernate 4 classloader we can no longer
do XYZ. Thus I've made it do ZXY instead.
For a PR you can either just copy verbatim the above or maybe add some refs/details:
JBIDE-1234 - hibernate tools 4 classloading is broken.
This should be applied not only to master but also branch jbosstools-4.0.x
With this github dashboard and git log messages becomes much more informative.
Links with more background/tips with respect to commits/messages/workflows:
http://who-t.blogspot.cz/2009/12/on-commit-messages.html
http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
/max
_______________________________________________
jbosstools-dev mailing list
jbosstools-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/jbosstools-dev
4402
days inactive
4403
days old
jbosstools-dev@lists.jboss.org
10 comments
6 participants
participants (6)
-
Denis Golovin -
Fred Bricon -
Martin Malina -
Max Rydahl Andersen -
Nick Boldt -
Xavier Coulon