Re: [prelink-cross v2] Fixed bug #13529


Meh Mbeh Ida Delphine
 

Awesome, thanks for the feedback. 

On Thu, Oct 8, 2020 at 6:29 PM Tim Orling <ticotimo@...> wrote:
Hi Ida! Thank you so much for the patch.

Just a few things to help you along:
OpenEmbedded and Yocto Project are tightly coupled, so that is why these references are coming from openembedded.
(1) the subject line should be descriptive of what the change is, so it would be better to say "[prelink-cross] Add SPDX license headers to all source files"
This is because it will be permanent git history and we want to be able to rapidly scan the "shortlog" that you would see with "git log --oneline" and know immediately what was done in a given commit
(2) In the body of the commit message (after the first line) you can put in more detail when it is appropriate, for instance you could mention the files that did not have a license and you skipped them, etc.
This is a way for us to communicate the thought process we followed, or the steps we did to reproduce the problem, or any other communication that might be helpful
(3) We have a convention to use [YOCTO#13529] to show that the patch fixes a bug from the Yocto Project Bugzilla.
This is to make it possible for automated capturing of the "tags" that tell us which commits addressed which bugs.
(4) One last thing, when sending follow-up patches (v2, v3, etc.), we ask to put what changed from v1 to v2 to v3 underneath the --- in the git log. You can make this easy by adding --annotate to the git send-email command and it will give you and opportunity to edit the log before you send the patch.

Some of this is tribal knowledge and perhaps not captured in the wiki and we should improve that. Or put it into the Yocto Project documentation...but it should be captured somewhere :)

--Tim




On Thu, Oct 8, 2020 at 9:38 AM Meh Mbeh Ida Delphine <idadelm@...> wrote:
Signed-off-by: Meh Mbeh Ida Delphine <idadelm@...>
---

^^^ anything underneath the --- will not show up in the commit log, so this is where we put things that are effemeral, such as "Changes since v2"
 
 src/arch-alpha.c   | 15 ++-------------

<snip>

Join yocto@lists.yoctoproject.org to automatically receive all group messages.