[Sound-open-firmware] A kind reminder on writing commit messages
19 Dec
2019
19 Dec
'19
10 p.m.
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.
1829
Age (days ago)
1829
Last active (days ago)
0 comments
1 participants
participants (1)
-
Daniel Baluta