Git development
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: git@vger.kernel.org
Subject: [PATCH 2/2] SubmittingPatches: describe cover letter
Date: Tue,  2 Jun 2026 18:08:08 +0900	[thread overview]
Message-ID: <20260602090808.87837-3-gitster@pobox.com> (raw)
In-Reply-To: <20260602090808.87837-1-gitster@pobox.com>

We talk about how a commit log message should look like, but do not
give advice on writing the cover letter to sell a series to widest
possible audience.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
 Documentation/SubmittingPatches | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index dec8aea4cb..8ff1792b9b 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -472,6 +472,25 @@ highlighted above.
 Only capitalize the very first letter of the trailer, i.e. favor
 "Signed-off-by" over "Signed-Off-By" and "Acked-by:" over "Acked-By".
 
+[[cover-letter]]
+=== Cover Letter
+
+The purpose of your cover letter is to sell your changes, explain what
+they are about, and get your target audience interested enough to read
+the patches.
+
+. Make sure your target audience can understand what the patches are
+  about and why they are needed without prior context.
+
+. For a second or subsequent iteration of the same topic, make sure
+  people who missed the earlier discussion can still understand what
+  the patches are about, so they can judge if the topic is worth their
+  time to read and comment on.
+
+. To help those who are familiar with earlier iterations, give a
+  summary of changes since the previous rounds.
+
+
 [[ai]]
 === Use of Artificial Intelligence (AI)
 
-- 
2.54.0-567-gf25c749695


  parent reply	other threads:[~2026-06-02  9:08 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-06-02  9:08 [PATCH 0/2] Small updates to SubmittingPatches Junio C Hamano
2026-06-02  9:08 ` [PATCH 1/2] SubmittingPatches: separate typofixes section Junio C Hamano
2026-06-02 14:24   ` Christian Couder
2026-06-02 14:28     ` Junio C Hamano
2026-06-02 15:16       ` Christian Couder
2026-06-02 14:46   ` Kristoffer Haugsbakk
2026-06-02  9:08 ` Junio C Hamano [this message]
2026-06-02 12:07   ` [PATCH 2/2] SubmittingPatches: describe cover letter Patrick Steinhardt
2026-06-02 13:36     ` Junio C Hamano
2026-06-02 12:29   ` Derrick Stolee
2026-06-02 13:43     ` Junio C Hamano
2026-06-02 14:43 ` [PATCH v2 0/2] Small updates to SubmittingPatches Junio C Hamano
2026-06-02 14:43   ` [PATCH v2 1/2] SubmittingPatches: separate typofixes section Junio C Hamano
2026-06-02 14:43   ` [PATCH v2 2/2] SubmittingPatches: describe cover letter Junio C Hamano
2026-06-02 15:24   ` [PATCH v2 0/2] Small updates to SubmittingPatches Derrick Stolee

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260602090808.87837-3-gitster@pobox.com \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox