diff options
author | Quentin Schulz <quentin.schulz@cherry.de> | 2025-09-18 12:24:44 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2025-09-26 16:40:40 +0100 |
commit | 910119e1e6448b044508bdc99adf965bd7fe5561 (patch) | |
tree | 871491423ed85c132414f53f214a4f8b3ce26719 /documentation | |
parent | 2e053bfdabd5edf5d14ad75e19efc3d7bb8bd56d (diff) | |
download | poky-910119e1e6448b044508bdc99adf965bd7fe5561.tar.gz |
contributor-guide: submit-changes: number instruction list in commit your changes
... so that it's clear that you need to read and follow each and every
instruction in this list.
(From yocto-docs rev: c628a489f081925fabaabb5acac6752251150269)
Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/contributor-guide/submit-changes.rst | 152 |
1 files changed, 76 insertions, 76 deletions
diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst index 49790ee14e..29af1ced95 100644 --- a/documentation/contributor-guide/submit-changes.rst +++ b/documentation/contributor-guide/submit-changes.rst | |||
@@ -127,82 +127,82 @@ to add the upgraded version. | |||
127 | 127 | ||
128 | $ git commit -sa | 128 | $ git commit -sa |
129 | 129 | ||
130 | - The ``-s`` option of ``git commit`` adds a "Signed-off-by:" line | 130 | #. The ``-s`` option of ``git commit`` adds a "Signed-off-by:" line |
131 | to your commit message. There is the same requirement for contributing | 131 | to your commit message. There is the same requirement for contributing |
132 | to the Linux kernel. Adding such a line signifies that you, the | 132 | to the Linux kernel. Adding such a line signifies that you, the |
133 | submitter, have agreed to the `Developer's Certificate of Origin 1.1 | 133 | submitter, have agreed to the `Developer's Certificate of Origin 1.1 |
134 | <https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin>`__ | 134 | <https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin>`__ |
135 | as follows: | 135 | as follows: |
136 | 136 | ||
137 | .. code-block:: none | 137 | .. code-block:: none |
138 | 138 | ||
139 | Developer's Certificate of Origin 1.1 | 139 | Developer's Certificate of Origin 1.1 |
140 | 140 | ||
141 | By making a contribution to this project, I certify that: | 141 | By making a contribution to this project, I certify that: |
142 | 142 | ||
143 | (a) The contribution was created in whole or in part by me and I | 143 | (a) The contribution was created in whole or in part by me and I |
144 | have the right to submit it under the open source license | 144 | have the right to submit it under the open source license |
145 | indicated in the file; or | 145 | indicated in the file; or |
146 | 146 | ||
147 | (b) The contribution is based upon previous work that, to the best | 147 | (b) The contribution is based upon previous work that, to the best |
148 | of my knowledge, is covered under an appropriate open source | 148 | of my knowledge, is covered under an appropriate open source |
149 | license and I have the right under that license to submit that | 149 | license and I have the right under that license to submit that |
150 | work with modifications, whether created in whole or in part | 150 | work with modifications, whether created in whole or in part |
151 | by me, under the same open source license (unless I am | 151 | by me, under the same open source license (unless I am |
152 | permitted to submit under a different license), as indicated | 152 | permitted to submit under a different license), as indicated |
153 | in the file; or | 153 | in the file; or |
154 | 154 | ||
155 | (c) The contribution was provided directly to me by some other | 155 | (c) The contribution was provided directly to me by some other |
156 | person who certified (a), (b) or (c) and I have not modified | 156 | person who certified (a), (b) or (c) and I have not modified |
157 | it. | 157 | it. |
158 | 158 | ||
159 | (d) I understand and agree that this project and the contribution | 159 | (d) I understand and agree that this project and the contribution |
160 | are public and that a record of the contribution (including all | 160 | are public and that a record of the contribution (including all |
161 | personal information I submit with it, including my sign-off) is | 161 | personal information I submit with it, including my sign-off) is |
162 | maintained indefinitely and may be redistributed consistent with | 162 | maintained indefinitely and may be redistributed consistent with |
163 | this project or the open source license(s) involved. | 163 | this project or the open source license(s) involved. |
164 | 164 | ||
165 | - Provide a single-line summary of the change and, if more | 165 | #. Provide a single-line summary of the change and, if more |
166 | explanation is needed, provide more detail in the description of the | 166 | explanation is needed, provide more detail in the description of the |
167 | commit. This summary is typically viewable in the "shortlist" of | 167 | commit. This summary is typically viewable in the "shortlist" of |
168 | changes. Thus, providing something short and descriptive that | 168 | changes. Thus, providing something short and descriptive that |
169 | gives the reader a summary of the change is useful when viewing a | 169 | gives the reader a summary of the change is useful when viewing a |
170 | list of many commits. You should prefix this short description | 170 | list of many commits. You should prefix this short description |
171 | with the recipe name (if changing a recipe), or else with the | 171 | with the recipe name (if changing a recipe), or else with the |
172 | short form path to the file being changed. | 172 | short form path to the file being changed. |
173 | 173 | ||
174 | .. note:: | 174 | .. note:: |
175 | 175 | ||
176 | To find a suitable prefix for the commit summary, a good idea | 176 | To find a suitable prefix for the commit summary, a good idea |
177 | is to look for prefixes used in previous commits touching the | 177 | is to look for prefixes used in previous commits touching the |
178 | same files or directories:: | 178 | same files or directories:: |
179 | 179 | ||
180 | git log --oneline <paths> | 180 | git log --oneline <paths> |
181 | 181 | ||
182 | - For the commit description, provide detailed information | 182 | #. For the commit description, provide detailed information |
183 | that describes what you changed, why you made the change, and the | 183 | that describes what you changed, why you made the change, and the |
184 | approach you used. It might also be helpful if you mention how you | 184 | approach you used. It might also be helpful if you mention how you |
185 | tested the change. Provide as much detail as you can in the commit | 185 | tested the change. Provide as much detail as you can in the commit |
186 | description. | 186 | description. |
187 | 187 | ||
188 | .. note:: | 188 | .. note:: |
189 | 189 | ||
190 | If the single line summary is enough to describe a simple | 190 | If the single line summary is enough to describe a simple |
191 | change, the commit description can be left empty. | 191 | change, the commit description can be left empty. |
192 | 192 | ||
193 | - If the change addresses a specific bug or issue that is associated | 193 | #. If the change addresses a specific bug or issue that is associated |
194 | with a bug-tracking ID, include a reference to that ID in the body of the | 194 | with a bug-tracking ID, include a reference to that ID in the body of the |
195 | commit message. For example, the Yocto Project uses a | 195 | commit message. For example, the Yocto Project uses a |
196 | specific convention for bug references --- any commit that addresses | 196 | specific convention for bug references --- any commit that addresses |
197 | a specific bug should use the following form for the body of the commit | 197 | a specific bug should use the following form for the body of the commit |
198 | message. Be sure to use the actual bug-tracking ID from | 198 | message. Be sure to use the actual bug-tracking ID from |
199 | Bugzilla for bug-id:: | 199 | Bugzilla for bug-id:: |
200 | 200 | ||
201 | single-line summary of change | 201 | single-line summary of change |
202 | 202 | ||
203 | Fixes [YOCTO #bug-id] | 203 | Fixes [YOCTO #bug-id] |
204 | 204 | ||
205 | detailed description of change | 205 | detailed description of change |
206 | 206 | ||
207 | #. *Crediting contributors:* By using the ``git commit --amend`` command, | 207 | #. *Crediting contributors:* By using the ``git commit --amend`` command, |
208 | you can add some tags to the commit description to credit other contributors | 208 | you can add some tags to the commit description to credit other contributors |