On 17/04/17 16:41, David Major wrote:
I'd like to add to this a reminder that commit messages should describe
the _change_ and not the _symptom_. In other words, "Bug XYZ: Crash at
Foo::Bar" is not a good summary.

An unfortunate pattern I see is non-descriptive commit messages for tests, which is particularly problematic for web-platform-tests that are later upstreamed. A commit message like "Bug 1234 - Part 2: Tests" is not totally terrible in the context of Mozilla Central — although obviously more detail about what is, and especially what is not, covered would be appreciated — but "Part 2: Tests" is utterly meaningless upstream.

When adding web-platform-tests it would be really appreciated if people would consider how the commit message will read outside the m-c repository, and at least mention which features the tests are intending to cover. Ideally we would also avoid bugzilla review cruft like part numbers, but I understand that a more realistic solution there is for the tooling to strip out more of this when upstreaming.
_______________________________________________
dev-platform mailing list
dev-platform@lists.mozilla.org
https://lists.mozilla.org/listinfo/dev-platform

Reply via email to