[PATCH] contributor-guide: recommend format.forceInBodyFrom

Tim Orling
2024-05-02T15:27:37Z

We are seeing a lot of patches failing when the From:
line is not contained in the message body. It is probably
better to just recommend to force the in-body From: to be
present globally.

Signed-off-by: Tim Orling <tim.orling@konsulko.com>
---
documentation/contributor-guide/submit-changes.rst | 5 +++++
1 file changed, 5 insertions(+)

diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst
index 47a416b24..c292a143a 100644
--- a/documentation/contributor-guide/submit-changes.rst
+++ b/documentation/contributor-guide/submit-changes.rst
@@ -65,6 +65,11 @@ use to identify your commits::
git config --global user.name "Ada Lovelace"
git config --global user.email "ada.lovelace@gmail.com"

+To ensure that your patches are formatted properly, it is also
+recommended to set::
+
+ git config --global format.forceInBodyFrom true
+
Clone the Git repository for the component to modify
----------------------------------------------------

--
2.43.2