Good commit messages

classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view
|

Good commit messages

David Cook

Hi all,

 

So Jonathan linked me to this the other day: https://wiki.koha-community.org/wiki/Commit_messages#Good_commit_messages_2  

 

I don’t understand one of the “Bad commit messages” though. I thought everyone always starts a good commit message with “Bug 12345 - “. Am I missing something there?

 

Personally, I don’t think you can always explain what the *bug* is in 50 characters, although I’m super on board for the commit message containing what the *fix* does.

 

I’m writing a commit message for https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=21131 and struggling a bit as the bug is actually kind of convoluted.

 

David Cook

Systems Librarian

Prosentient Systems

72/330 Wattle St

Ultimo, NSW 2007

Australia

 

Office: 02 9212 0899

Direct: 02 8005 0595

 


_______________________________________________
Koha-devel mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
Reply | Threaded
Open this post in threaded view
|

Re: Good commit messages

Chris Cormack-7
Yes Bug 12345: not -

And 50 chars is just the first line you can put a lot more in the rest. The bug number is the important bit in the first line.

Chris



On 30 July 2018 4:39:46 PM NZST, David Cook <[hidden email]> wrote:

Hi all,

 

So Jonathan linked me to this the other day: https://wiki.koha-community.org/wiki/Commit_messages#Good_commit_messages_2  

 

I don’t understand one of the “Bad commit messages” though. I thought everyone always starts a good commit message with “Bug 12345 - “. Am I missing something there?

 

Personally, I don’t think you can always explain what the *bug* is in 50 characters, although I’m super on board for the commit message containing what the *fix* does.

 

I’m writing a commit message for https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=21131 and struggling a bit as the bug is actually kind of convoluted.

 

David Cook

Systems Librarian

Prosentient Systems

72/330 Wattle St

Ultimo, NSW 2007

Australia

 

Office: 02 9212 0899

Direct: 02 8005 0595

 


--
Sent from my Android device with K-9 Mail. Please excuse my brevity.
_______________________________________________
Koha-devel mailing list
[hidden email]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/