linux/poky.git/documentation/contributor-guide/submit-changes.rst, branch scarthgap-5.0.15

documentation: link to the Releases page on yoctoproject.org instead of wiki

2025-11-26T15:50:36+00:00

We have a machine-generated Releases page[1] which is preferable to the wiki. [1] https://www.yoctoproject.org/development/releases/ (From yocto-docs rev: 5af5e64e42732c0919cad499e79ff35ca4255a86) Signed-off-by: Ross Burton Signed-off-by: Antonin Godard (cherry picked from commit 46a9172fd17aa518028e35b8c874e74889079094) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

contributor-guide: submit-changes: make "Crediting contributors" part of "Commit your changes"

2025-09-30T15:01:59+00:00

There's no need to differentiate crediting contributors from committing your changes, so let's simply make it the last step of "Commit your changes" section. This simply indents the text so it's now part of "Commit your changes" list instead of the main list in the "Implement and commit changes" section. Because of this reorganisation, the instruction to use "git commit --amend" to add the contributors is moved to a note, and the first few sentences are reworded to better match the wording of other items in the "Commit your changes" list of instructions. (From yocto-docs rev: 6ba61d7bc3e641b3d4194f2d99a276f3b29f82b8) Signed-off-by: Quentin Schulz Signed-off-by: Antonin Godard (cherry picked from commit eff4d14e28d323ebfdaeb0c5c805b5f1e2ad153d) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

contributor-guide: submit-changes: number instruction list in commit your changes

2025-09-30T15:01:59+00:00

... so that it's clear that you need to read and follow each and every instruction in this list. (From yocto-docs rev: 6dfef402b2785675870d513f4afeed6b7e7a4df1) Signed-off-by: Quentin Schulz Signed-off-by: Antonin Godard (cherry picked from commit c628a489f081925fabaabb5acac6752251150269) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

contributor-guide: submit-changes: reword commit message instructions

2025-09-30T15:01:59+00:00

This should hopefully make it clearer what is expected from the contributor. This follows my understanding of git-commit(1)[1] where the following is a git commit message: """ git commit title git commit description """ I'm putting the "Fixes [YOCTO" line in "body of the commit message" so it's understood as being different from the git commit description so that the note admonition allowing us to have an empty commit description doesn't apply to the "Fixes [YOCTO" line. [1] https://www.man7.org/linux/man-pages/man1/git-commit.1.html#DISCUSSION (From yocto-docs rev: f0f9d40a04cba684a476caaa053b6f24ade9fb99) Signed-off-by: Quentin Schulz Signed-off-by: Antonin Godard (cherry picked from commit b84903a760350bd118c56ea9ce4e98039edf6e55) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

contributor-guide: submit-changes: make the Cc tag follow kernel guidelines

2025-09-30T15:01:59+00:00

The kernel docs specifies[1] a Cc: tag and not CC: tag, so let's align with that. [1] https://www.kernel.org/doc/html/latest/process/submitting-patches.html#when-to-use-acked-by-cc-and-co-developed-by (From yocto-docs rev: 49934860119ccd0844b0c600ea6be0a776b11a12) Signed-off-by: Quentin Schulz Signed-off-by: Antonin Godard (cherry picked from commit f800fef4e9e2c1d3584ac49be8324638d2923b17) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

contributor-guide: submit-changes: align CC tag description

2025-09-30T15:01:59+00:00

The other tag descriptions have the double colon outside of the highlight, and start the sentence with a lowercase word, so let's align the CC tag with those. (From yocto-docs rev: 4dba30a040fd64e4e547bc485878b90e691c1373) Signed-off-by: Quentin Schulz Signed-off-by: Antonin Godard (cherry picked from commit f116e93fb335e9d0f85891c4cb501bcf55b18ccf) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

contributor-guide: submit-changes: clarify example with Yocto bug ID

2025-09-30T15:01:59+00:00

The example could be understood as the content of the commit message once the editor (git config core.editor) opens, where the first line is the actual commit title and not the commit description. This example would make the Fixes line the commit title, which is not what we want. In short, according to my understanding of git-commit(1): The following is a git commit message: """ git commit title git commit description """ Reported-by: Barne Carstensen (From yocto-docs rev: 5244b934db878a5bdb73118f1629cf20e391faa7) Signed-off-by: Quentin Schulz Signed-off-by: Antonin Godard (cherry picked from commit a5862406bf3230befe9db9f2539bbbc86c02015d) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

contributor-guide: submit-changes: fix improper bold string

2025-09-30T15:01:59+00:00

I don't know what was the initial intent but this doesn't seem right, so let's remove the bold formatting. Fixes: 4abe87cb20d3 ("contributor-guide: submit-changes: detail commit and patch creation") Cc: Michael Opdenacker (From yocto-docs rev: 80be07404bd8215b198f5fb0936e3786072559b6) Signed-off-by: Quentin Schulz Signed-off-by: Antonin Godard (cherry picked from commit 6c499b3796a578a0fe4c319c9547b4321b0d41df) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

contributor-guide/submit-changes: encourage patch version changelogs

2025-05-19T15:32:49+00:00

Add a section after the 'git format-patch' information encouraging developers to add patch version changelogs to their patch updates. (From yocto-docs rev: 78fd3b3f1ec797dfe3648509a1945241b50640d5) Signed-off-by: Trevor Woerner Reviewed-by: Quentin Schulz Signed-off-by: Antonin Godard (cherry picked from commit 2e3a37c4607b296956993e557d1786c4876e5722) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman

contributor-guide/submit-changes: add policy on AI generated code

2025-02-21T14:25:06+00:00

Based on message by Richard Purdie on the yocto-docs list: https://lists.yoctoproject.org/g/docs/message/6300 Re-formatted for the Yocto Project documentation syntax. (From yocto-docs rev: da3aa5ba9387ca5bb7ddd75fe6f7962d0629ea90) Signed-off-by: Antonin Godard (cherry picked from commit a72dd13e6841b621c9e8f904dfaa440c186d2959) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman