kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

MyFirstContribution: reference "The cover letter" in "Preparing Email" 

The previous commit added a standalone section on the purpose of the
cover letter, drawing inspiration from the existing content of the
"Preparing Email" section.

Adjust "Preparing Email" to reference "The cover letter", to avoid
content duplication.

Also, use the imperative mode for the cover letter subject, as is done
in "The cover letter".

Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Philippe Blain 2022-05-12 23:43:35 +00:00 committed by Junio C Hamano
parent afc8c92535
commit e97d474c7a
1 changed files with 9 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
Documentation/MyFirstContribution.txt
View File

@ -1046,46 +1046,26 @@ directory you specified - you're nearly ready to send out your review!
[[preparing-cover-letter]] [[preparing-cover-letter]]
=== Preparing Email === Preparing Email


In addition to an email per patch, the Git community also expects your patches Since you invoked `format-patch` with `--cover-letter`, you've already got a
to come with a cover letter, typically with a subject line [PATCH 0/x] (where cover letter template ready. Open it up in your favorite editor.
x is the number of patches you're sending). Since you invoked `format-patch`
with `--cover-letter`, you've already got a template ready. Open it up in your
favorite editor.


You should see a number of headers present already. Check that your `From:` You should see a number of headers present already. Check that your `From:`
header is correct. Then modify your `Subject:` to something which succinctly header is correct. Then modify your `Subject:` (see <<cover-letter,above>> for
covers the purpose of your entire topic branch, for example: how to choose good title for your patch series):


---- ----
Subject: [PATCH 0/7] adding the 'psuh' command Subject: [PATCH 0/7] Add the 'psuh' command
---- ----


Make sure you retain the ``[PATCH 0/X]'' part; that's what indicates to the Git Make sure you retain the ``[PATCH 0/X]'' part; that's what indicates to the Git
community that this email is the beginning of a review, and many reviewers community that this email is the beginning of a patch series, and many
filter their email for this type of flag. reviewers filter their email for this type of flag.


You'll need to add some extra parameters when you invoke `git send-email` to add You'll need to add some extra parameters when you invoke `git send-email` to add
the cover letter. the cover letter.


Next you'll have to fill out the body of your cover letter. This is an important Next you'll have to fill out the body of your cover letter. Again, see
component of change submission as it explains to the community from a high level <<cover-letter,above>> for what content to include.
what you're trying to do, and why, in a way that's more apparent than just
looking at your diff. Be sure to explain anything your diff doesn't make clear
on its own.

Here's an example body for `psuh`:

----
Our internal metrics indicate widespread interest in the command
git-psuh - that is, many users are trying to use it, but finding it is
unavailable, using some unknown workaround instead.

The following handful of patches add the psuh command and implement some
handy features on top of it.

This patchset is part of the MyFirstContribution tutorial and should not
be merged.
----


The template created by `git format-patch --cover-letter` includes a diffstat. The template created by `git format-patch --cover-letter` includes a diffstat.
This gives reviewers a summary of what they're in for when reviewing your topic. This gives reviewers a summary of what they're in for when reviewing your topic.