IMO, the log message serves the following main purposes: - explains why the change was made, so reviewers can properly check that the diff agrees - identifies the change in the historical log so it can be found easily
Information necessary to understand the code should be added to the source, not the log message. It should not be necessary to read the log in order to understand the code -- we don't provide logs with the source. It's not always easy to get the balance right... On Sun, 5 Jul 2020 at 12:39, Matt Juntunen <matt.juntu...@hotmail.com> wrote: > > Yes, I should have modified that commit message to indicate that the change > was warranted. > -Matt > ________________________________ > From: Gilles Sadowski <gillese...@gmail.com> > Sent: Sunday, July 5, 2020 4:00 AM > To: Commons Developers List <dev@commons.apache.org> > Subject: [All][Geometry] Commit log (Was: [GitHub] ...) > > Hello. > > I'd like to collect some opinions about enforcing a minimal form in > commit messages. > My preference is that a log message is either > * terse, when the commit is trivial (e.g. "Javadoc" or "Unused variable"), or > * detailed but factual, if the change is not obvious. > > IMHO, a commit message should rarely (if ever) > * contain redundant words (such as "fix"), > * be a plain rewording of a trivial change (rather that the purpose of > the change), > * make the reviewer second-guess whether the change is warranted. > > Informal and uninformative/noisy messages might seem the new normal on > GitHub but does that mean that we pass on them in our projects? > > Regards, > Gilles > > Le sam. 4 juil. 2020 à 13:48, GitBox <g...@apache.org> a écrit : > > > > > > darkma773r commented on pull request #88: > > URL: > > https://github.com/apache/commons-geometry/pull/88#issuecomment-653756040 > > > > > > Merged in commit 6c90e34ff11fb9fa279d9b060abf70c14ce3cd2a > > > > > > --------------------------------------------------------------------- > To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org > For additional commands, e-mail: dev-h...@commons.apache.org > --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org For additional commands, e-mail: dev-h...@commons.apache.org
