From 89621bef97c6a37df8229377a47f5b30b1fcaf2d Mon Sep 17 00:00:00 2001
From: Greg Slonim <140188606+slonim-greg@users.noreply.github.com>
Date: Tue, 25 Jul 2023 14:21:34 +0100
Subject: [PATCH] docs(config): add clarification for gitAuthor format to avoid
 obscure errors during commits. (#23543)

Co-authored-by: Rhys Arkins <rhys@arkins.net>
---
 docs/usage/configuration-options.md | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/docs/usage/configuration-options.md b/docs/usage/configuration-options.md
index 1afdd2c5a5..f2a912c4e8 100644
--- a/docs/usage/configuration-options.md
+++ b/docs/usage/configuration-options.md
@@ -1105,7 +1105,12 @@ You can't use other filenames because Renovate only checks the default filename
 ## gitAuthor
 
 You can customize the Git author that's used whenever Renovate creates a commit.
-The `gitAuthor` option accepts a RFC5322-compliant string.
+The `gitAuthor` option accepts a [RFC5322](https://datatracker.ietf.org/doc/html/rfc5322)-compliant string.
+It's recommended to include a name followed by an email address, e.g.
+
+```
+Development Bot <dev-bot@my-software-company.com>
+```
 
 <!-- prettier-ignore -->
 !!! danger
-- 
GitLab