It's ok IMO to say "Add Javadoc" vs. "Fix Javadoc" vs. "Expand Javadoc". Plain "Javadoc" is ok if terse.
I like the format of the first line standing on its own as a sentence. Then there can be a blank line followed by details. That first line can be a JIRA title. For example, excluding the "---" --- [TEXT-178] The foo does not flibber the widget. Add a disabled test. --- Think about what you are saying in a commit comment helps maintainers. Think about what belongs in a commit comment vs in code comments or Javadoc. Gary On Sun, Jul 5, 2020, 04:00 Gilles Sadowski <gillese...@gmail.com> wrote: > 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 > >
