[Sound-open-firmware] A kind reminder on writing commit messages

Daniel Baluta daniel.baluta at nxp.com
Thu Dec 19 22:00:01 CET 2019


Hi all,

I'm now trying to understand some changes related to notifiers
and I would have really liked to see better commit description.

A kind reminder that when you write a commit message that commit serves
as documentation for poor readers that will later try to debug the code.

Even if the code looks obvious to you that might not look obvious for others.

So, please for non-trivial changes:

  *   explain why the commit is needed
  *   explain what is the problem that the commit tries to fix
  *   explain why the current solution is better than the old approach
  *   briefly explain how the new solution work

thanks,
Daniel.


More information about the Sound-open-firmware mailing list