dev-manual-common-tasks: Describe how to handle patch feedback

The contribution guidelines would benefit from a brief section on how to
address feedback from patch reviewers and how to re-submit amended
patches. The information here is based on my personal experience and on
the existing notes on the "How to submit a patch to OpenEmbedded" page
on the OE wiki.

(From yocto-docs rev: fcff5c524fdf2f465153319d0fdc6fb557b588dd)

Signed-off-by: Paul Barker <pbarker@konsulko.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Paul Barker
2020-11-23 18:02:17 +00:00
committed by Richard Purdie
parent 8b607a18b1
commit ed36bd89d7

View File

@@ -10982,6 +10982,28 @@ reduce the burden of patch review on maintainers.
Asking about the status of a patch or change is reasonable if the change
has been idle for a while with no feedback.
Responding to Patch Review
~~~~~~~~~~~~~~~~~~~~~~~~~~
You may get feedback on your submitted patches from other community members
or from the automated patchtest service. If issues are identified in your
patch then it is usually necessary to address these before the patch will be
accepted into the project. In this case you should amend the patch according
to the feedback and submit an updated version to the relevant mailing list,
copying in the reviewers who provided feedback to the previous version of the
patch.
The patch should be amended using ``git commit --amend`` or perhaps ``git
rebase`` for more expert git users. You should also modify the ``[PATCH]``
tag in the email subject line when sending the revised patch to mark the new
iteration as ``[PATCH v2]``, ``[PATCH v3]``, etc as appropriate. This can be
done by passing the ``-v`` argument to ``git format-patch`` with a version
number.
Lastly please ensure that you also test your revised changes. In particular
please don't just edit the patch file written out by ``git format-patch`` and
resend it.
Working With Licenses
=====================