Hi Tim, On Wed, Sep 14, 2022 at 07:44:27PM +0200, Tim Düsterhus wrote: > The fixes look correct to me, but the commit message is horrible. I've > attached the patch with a proper commit message (dropping the Signed-off-by > and adding a Co-authored-by). > > Best regards > Tim Düsterhus
> From e2fa51bc9f7e7d7d451df2ad9cd72071211faf6a Mon Sep 17 00:00:00 2001 > From: cui fliter <[email protected]> > Date: Mon, 29 Aug 2022 14:42:57 +0800 > Subject: [PATCH] CLEANUP: Fix typos in C comments > > see GitHub PR #1843 > > [Tim: Rephrased the commit message] > > Co-authored-by: Tim Duesterhus <[email protected]> Thanks, but quite honnestly, even this one is not a commit message. I mean, referencing an external issue for a complement of information is fine, but as the sole source, please no. First, it means that those who read the logs have zero info there, they need to open a browser, visit the project on github and enter the PR number just to get a very likely uninteresting context. Second it's not greppable. And third, imagine that one day a large company would decide to acquire github (yeah I know, purely fictional :-)) and to progressively change the conditions to the point that we're almost forced out. Suddenly, all such knowledge is lost. Forever. So commit messages must accurately describe the problem that they try to solve. External references for more info, more context etc is perfectly fine and welcome, but that must never be a shortcut for a lengthy message (and yes I know that here we're talking only about typos). Another thing to try to avoid is too generic subject lines. One good rule of thumb is to try to invent a subject line that is likely unique in the project. That doesn't mean it ought to be checked, just that if it's precise enough it will likely be unique. Here it could for example be something like: CLEANUP: Fix tiny typos in C comments in SSL and QUIC or: CLEANUP: quic,ssl: fix tiny typos in C comments You get the idea. Regarding the tag, it's fine (and even preferred) to keep the signed-off-by if you edit the patch, you just add yours below after a short description between square brackets. Example: Signed-off-by: joe user < > [Tim: authored a real commit message] Signed-off-by: Tim < > You must just not add an s-o-b for someone else if there wasn't (though you can always add yours). Regarding "co-authored", normally it's more for when the patch itself was adapted, but usually the first author places it from the start because all participants generally acknowledge co-authorship. Thanks! Willy
