mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-09-19 18:49:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
... 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 <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit c628a489f081925fabaabb5acac6752251150269)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
This commit is contained in:
Quentin Schulz
2025-09-18 12:24:44 +02:00
committed by Steve Sakoman
parent 1b7cb8a80c
commit 9baa7dfdfd
1 changed files with 58 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
documentation/contributor-guide/submit-changes.rst
View File

@@ -127,7 +127,7 @@ to add the upgraded version.
$ git commit -sa $ git commit -sa
- The ``-s`` option of ``git commit`` adds a "Signed-off-by:" line #. The ``-s`` option of ``git commit`` adds a "Signed-off-by:" line
to your commit message. There is the same requirement for contributing to your commit message. There is the same requirement for contributing
to the Linux kernel. Adding such a line signifies that you, the to the Linux kernel. Adding such a line signifies that you, the
submitter, have agreed to the `Developer's Certificate of Origin 1.1 submitter, have agreed to the `Developer's Certificate of Origin 1.1
@@ -162,7 +162,7 @@ to add the upgraded version.
maintained indefinitely and may be redistributed consistent with maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved. this project or the open source license(s) involved.
- Provide a single-line summary of the change and, if more #. Provide a single-line summary of the change and, if more
explanation is needed, provide more detail in the description of the explanation is needed, provide more detail in the description of the
commit. This summary is typically viewable in the "shortlist" of commit. This summary is typically viewable in the "shortlist" of
changes. Thus, providing something short and descriptive that changes. Thus, providing something short and descriptive that
@@ -179,7 +179,7 @@ to add the upgraded version.
git log --oneline <paths> git log --oneline <paths>
- For the commit description, provide detailed information #. For the commit description, provide detailed information
that describes what you changed, why you made the change, and the that describes what you changed, why you made the change, and the
approach you used. It might also be helpful if you mention how you approach you used. It might also be helpful if you mention how you
tested the change. Provide as much detail as you can in the commit tested the change. Provide as much detail as you can in the commit
@@ -190,7 +190,7 @@ to add the upgraded version.
If the single line summary is enough to describe a simple If the single line summary is enough to describe a simple
change, the commit description can be left empty. change, the commit description can be left empty.
- If the change addresses a specific bug or issue that is associated #. If the change addresses a specific bug or issue that is associated
with a bug-tracking ID, include a reference to that ID in the body of the with a bug-tracking ID, include a reference to that ID in the body of the
commit message. For example, the Yocto Project uses a commit message. For example, the Yocto Project uses a
specific convention for bug references --- any commit that addresses specific convention for bug references --- any commit that addresses