Hello, Jacques Le Roux <jacques.le.r...@les7arts.com> writes:
> Le 17/11/2019 à 19:16, Taher Alkhateeb a écrit : > >> I'm not sure what convention over configuration has to do with what >> you're saying :) > > It was because of this sentence in the reference link > > "This is a project specific convention that has no relation to any > requirements or limitations in Git. Yes, it is a fine convention for many > projects but it should not be required." > > And yes I abused the concept a bit :) I see our template as a configuration. > >> Anyway, it makes sense. Most GIT editors consider the first line to be >> subject, and third line onward is the body of the message. So perhaps >> we can move the (OFBIZ-XXXX) to the end of the first line or maybe >> make it the last line in the body or something like that. > > Finally, like Gil, I prefer to keep the 2 infos on the same line. It > would make less sense to have the issue number inside the body of the > message IMO to guess what make sense or not, I think considering the usage of that information matters. For instance a lot of UI ontop of Git show only the summary (the first line) in a first step to give an overview of the commit and require a user action to display the details (the body) of the message commit. So if we choose to put the ticket number in the summary it is because we find valuable to see it at first glance otherwise it is just noise. In other free software communities I work with, the bug ticket number was only considered as metadata (like our “thanks” part) put in the body so that it can be easily retrieved with ‘git log --grep=...’ when diving in the history. I personally don't see any value in having auto generated identifiers inside the summary of our commits, but if people in this community find it useful in their workflow, I don't mind following that convention. -- Mathieu Lirzin
