lkml.org 
[lkml]   [2024]   [Mar]   [11]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
From
Date
SubjectRe: [PATCH v6] dt-bindings: imx-pata: Convert to dtschema
On Mon, Mar 11, 2024 at 9:39 AM Damien Le Moal <dlemoal@kernel.org> wrote:
> It is simple: the commit message should always explain *WHAT* you did and
> *WHY*. This is to give some context to reviewers and to help with checking that
> your code actually does what you explained. This also helps with potential
> future issues with a change as the commit message remains in the git log history.
>
> Regardless of the version of your patch, always have the what & why explained
> in your commit message. This implies that the commit message must change if the
> patch content changes between versions. Keep in mind that the changelog added
> to a patch is lost when the patch is applied, but the commit message remains.

Thank you for your feedback and guidance.
Your advice regarding the necessity of explaining both the *WHAT* and
*WHY* behind each change is duly noted. Moving forward, I will ensure
that my commit messages provide comprehensive context to facilitate
smoother reviewing processes and to maintain a clear log history for
potential future issues.

Thanks & regards,
Animesh

\
 
 \ /
  Last update: 2024-05-27 15:43    [W:1.843 / U:0.072 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site