I cannot stress enough how valuable this is: > When you have to clean up problems in code, being able to annotate the > code (git blame), find the origin, > track the original description and > discussion, and the people involved in it, is invaluable The other day I had to investigate what look like a regression, a git blame give me the relevant commit, but unfortunately the commit didn't follow the recommended pattern ... and just by looking at the code and commit message it was not clear what was going on and why the code was changed. I had to ping directly the developer and we spend some time finding the original issue. The original issue give all the info we need and clarified everything :) On Thu, 2020-01-09 at 08:04 +0100, Andrea Aime wrote: > On Wed, Jan 8, 2020 at 8:08 PM Jody Garnett <jody.garn...@gmail.com> wrote:> > > What is the advantage of this format? Does it come from an automatic tool? > > The commit message habit has been there for a while... the automated tool > > is called Andrea, crushing several weekends > to look up tickets in Jira that have been left abandoned but open, while the > work is actually done. > You all have been relying on this automation for over 10 years without much > noticing I think, but has limited > the Jira tendency to work towards becoming a dumpster. > > Generally speaking, you want to have the ticket number in all your commit > > messages, for very basic reasons > (I'm actually surprised you work on projects where that does not happen, must > be a tracking nightmare to look > in their history...): > > https://softwareengineering.stackexchange.com/questions/308084/is-there-any-downside-to-commit-messages-containing-the-ticket-number> > > > When you have to clean up problems in code, being able to annotate the > > code (git blame), find the origin, > track the original description and discussion, and the people involved in it, > is invaluable > While it does not always work, it often allows to figure out why things were > done that way, > instead of just having a shortsighted and preconceived personal notion of > what the code should be doing. > > Regards > Andrea > > == > GeoServer Professional Services from the experts! Visit http://goo.gl/it488V > for more information. > for more information. > == > > Ing. Andrea Aime > @geowolf > Technical Lead > > GeoSolutions S.A.S. > Via di Montramito 3/A > 55054 Massarosa (LU) > phone: +39 0584 962313 > fax: +39 0584 1660272 > mob: +39 339 8844549 > > http://www.geo-solutions.it> http://twitter.com/geosolutions_it > > > > ------------------------------------------------------- > > Con riferimento alla normativa sul trattamento dei dati personali (Reg. UE 2016/679 - Regolamento generale sulla protezione dei dati “GDPR”), si precisa che ogni circostanza inerente alla presente email (il suo contenuto, gli eventuali allegati, etc.) è un dato la cui conoscenza è riservata al/i solo/i destinatario/i indicati dallo scrivente. Se il messaggio Le è giunto per errore, è tenuta/o a cancellarlo, ogni altra operazione è illecita. Le sarei comunque grato se potesse darmene notizia.
This email is intended only for the person or entity to which it is addressed and may contain information that is privileged, confidential or otherwise protected from disclosure. We remind that - as provided by European Regulation 2016/679 “GDPR” - copying, dissemination or use of this e-mail or the information herein by anyone other than the intended recipient is prohibited. If you have received this email by mistake, please notify us immediately by telephone or e-mail.> > _______________________________________________ > GeoTools-Devel mailing list > GeoTools-Devel@lists.sourceforge.net> https://lists.sourceforge.net/lists/listinfo/geotools-devel> -- Regards, Nuno Oliveira == GeoServer Professional Services from the experts! Visit http://goo.gl/it488V for more information. == Nuno Miguel Carvalho Oliveira @nmcoliveira Software Engineer GeoSolutions S.A.S. Via di Montramito 3/A 55054 Massarosa (LU) Italy phone: +39 0584 962313 fax: +39 0584 1660272 http://www.geo-solutions.it http://twitter.com/geosolutions_it ------------------------------------------------------- Con riferimento alla normativa sul trattamento dei dati personali (Reg. UE 2016/679 - Regolamento generale sulla protezione dei dati “GDPR”), si precisa che ogni circostanza inerente alla presente email (il suo contenuto, gli eventuali allegati, etc.) è un dato la cui conoscenza è riservata al/i solo/i destinatario/i indicati dallo scrivente. Se il messaggio Le è giunto per errore, è tenuta/o a cancellarlo, ogni altra operazione è illecita. Le sarei comunque grato se potesse darmene notizia. This email is intended only for the person or entity to which it is addressed and may contain information that is privileged, confidential or otherwise protected from disclosure. We remind that - as provided by European Regulation 2016/679 “GDPR” - copying, dissemination or use of this e-mail or the information herein by anyone other than the intended recipient is prohibited. If you have received this email by mistake, please notify us immediately by telephone or e-mail.
_______________________________________________ GeoTools-Devel mailing list GeoTools-Devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/geotools-devel
