On Tue, Apr 18, 2017 at 02:10:21AM +0300, smaug wrote: > On 04/17/2017 06:16 PM, Boris Zbarsky wrote: > > A quick reminder to patch authors and reviewers. > > > > Changesets should have commit messages. The commit message should describe > > not just the "what" of the change but also the "why". This is especially > > true in cases when the "what" is obvious from the diff anyway; for larger > > changes it makes sense to have a summary of the "what" in the commit > > message. > > > > As a specific example, if your diff is a one-line change that changes a > > method call argument from "true" to "false", having a commit message that > > says > > "change argument to mymethod from true to false" is not very helpful at > > all. A good commit message in this situation will at least mention the > > meaning for the argument. If that does not make it clear why the change is > > being made, the commit message should explain the "why". > > > > Thank you, > > Boris > > > > P.S. Yes, this was prompted by a specific changeset I saw. This changeset > > had been marked r+, which means neither the patch author not the reviewer > > really thought about this problem. > > > And reminder, commit messages should *not* be stories about how you ended up > with this particular change. They should just tell "what" and "why". > It seems like using mozreview leads occasionally writing stories (which is > totally fine as a bugzilla comment). > Overlong unrelated commit messages just make it harder to read blame.
Stories about how you end up with a particular change can be important as to why the change was not done another way. Mike _______________________________________________ dev-platform mailing list dev-platform@lists.mozilla.org https://lists.mozilla.org/listinfo/dev-platform
