summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorQuentin Schulz <quentin.schulz@cherry.de>2025-09-18 12:24:45 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2025-09-26 16:40:40 +0100
commit2cc3a69ed2cdd6950d1e9191c360654f8d17ae4d (patch)
treed87bf5634cff2208d350d30a965284275b7a5610
parent910119e1e6448b044508bdc99adf965bd7fe5561 (diff)
downloadpoky-2cc3a69ed2cdd6950d1e9191c360654f8d17ae4d.tar.gz
contributor-guide: submit-changes: make "Crediting contributors" part of "Commit your changes"
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: eff4d14e28d323ebfdaeb0c5c805b5f1e2ad153d) 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>
-rw-r--r--documentation/contributor-guide/submit-changes.rst54
1 files changed, 29 insertions, 25 deletions
diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst
index 29af1ced95..e3b29500d3 100644
--- a/documentation/contributor-guide/submit-changes.rst
+++ b/documentation/contributor-guide/submit-changes.rst
@@ -204,31 +204,35 @@ to add the upgraded version.
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 #. If other people participated in this patch, add some tags to the commit
208 you can add some tags to the commit description to credit other contributors 208 description to credit other contributors to the change:
209 to the change: 209
210 210 - ``Reported-by``: name and email of a person reporting a bug
211 - ``Reported-by``: name and email of a person reporting a bug 211 that your commit is trying to fix. This is a good practice
212 that your commit is trying to fix. This is a good practice 212 to encourage people to go on reporting bugs and let them
213 to encourage people to go on reporting bugs and let them 213 know that their reports are taken into account.
214 know that their reports are taken into account. 214
215 215 - ``Suggested-by``: name and email of a person to credit for the
216 - ``Suggested-by``: name and email of a person to credit for the 216 idea of making the change.
217 idea of making the change. 217
218 218 - ``Tested-by``, ``Reviewed-by``: name and email for people having
219 - ``Tested-by``, ``Reviewed-by``: name and email for people having 219 tested your changes or reviewed their code. These fields are
220 tested your changes or reviewed their code. These fields are 220 usually added by the maintainer accepting a patch, or by
221 usually added by the maintainer accepting a patch, or by 221 yourself if you submitted your patches to early reviewers,
222 yourself if you submitted your patches to early reviewers, 222 or are submitting an unmodified patch again as part of a
223 or are submitting an unmodified patch again as part of a 223 new iteration of your patch series.
224 new iteration of your patch series. 224
225 225 - ``Cc``: name and email of people you want to send a copy
226 - ``Cc``: name and email of people you want to send a copy 226 of your changes to. This field will be used by ``git send-email``.
227 of your changes to. This field will be used by ``git send-email``. 227
228 228 See `more guidance about using such tags
229 See `more guidance about using such tags 229 <https://www.kernel.org/doc/html/latest/process/submitting-patches.html#using-reported-by-tested-by-reviewed-by-suggested-by-and-fixes>`__
230 <https://www.kernel.org/doc/html/latest/process/submitting-patches.html#using-reported-by-tested-by-reviewed-by-suggested-by-and-fixes>`__ 230 in the Linux kernel documentation.
231 in the Linux kernel documentation. 231
232 .. note::
233
234 One can amend an existing git commit message to add missing tags for
235 contributors with the ``git commit --amend`` command.
232 236
233Test your changes 237Test your changes
234----------------- 238-----------------