From: Junio C Hamano <gitster@pobox.com>
To: "Philippe Blain via GitGitGadget" <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org, Emily Shaffer <emilyshaffer@google.com>,
Johannes Schindelin <Johannes.Schindelin@gmx.de>,
Victoria Dye <vdye@github.com>,
Eric Sunshine <sunshine@sunshineco.com>,
Philippe Blain <levraiphilippeblain@gmail.com>
Subject: Re: [PATCH v2 2/5] MyFirstContribution: add standalone section on cover letter
Date: Wed, 11 May 2022 03:01:24 -0700 [thread overview]
Message-ID: <xmqqa6boo0az.fsf@gitster.g> (raw)
In-Reply-To: 9552d80a80d9574c8f256696fad06f48b39b51c9.1652233654.git.gitgitgadget@gmail.com
"Philippe Blain via GitGitGadget" <gitgitgadget@gmail.com> writes:
> +The body of the cover letter is used to give additional context to reviewers.
> +Be sure to explain anything your patches don't make clear on their own, but
> +remember that since the cover letter is not recorded in the commit history,
> +anything that might be useful to future readers of the repository's history
> +should be in your commit messages, not in your cover letter.
I agree with only a half of the last sentence.
Things that are useful for "git log" readers should be in the commit
message (but that goes without saying---by definition "git log"
readers are reading commit messages). If that material helps to
understand the overall topic structure by the reviewers, it is not
wrong to have that _also_ in your cover letter. IOW, I sense that
"not in your cover letter" is a bit too strong.
Other than that, I found that 1/5 and 2/5 are very nicely written.
Thanks.
next prev parent reply other threads:[~2022-05-11 10:02 UTC|newest]
Thread overview: 43+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-04-27 19:04 [PATCH 0/3] Improve MyFirstContribution's GitGitGadget section Philippe Blain via GitGitGadget
2022-04-27 19:04 ` [PATCH 1/3] MyFirstContribution: move cover letter description to a separate file Philippe Blain via GitGitGadget
2022-04-27 21:15 ` Eric Sunshine
2022-04-27 22:02 ` Philippe Blain
2022-04-27 21:48 ` Junio C Hamano
2022-04-28 18:16 ` Philippe Blain
2022-04-27 19:04 ` [PATCH 2/3] MyFirstContribution: also explain cover letter in GitGitGadget section Philippe Blain via GitGitGadget
2022-04-27 20:43 ` Victoria Dye
2022-04-28 18:21 ` Philippe Blain
2022-04-29 16:27 ` Victoria Dye
2022-05-10 23:45 ` Philippe Blain
2022-04-27 19:04 ` [PATCH 3/3] MyFirstContribution: drop PR description for GGG single-patch contributions Philippe Blain via GitGitGadget
2022-04-27 21:56 ` Junio C Hamano
2022-04-28 18:25 ` Philippe Blain
2022-04-28 19:43 ` Junio C Hamano
2022-05-11 1:47 ` [PATCH v2 0/5] Improve MyFirstContribution's GitGitGadget section Philippe Blain via GitGitGadget
2022-05-11 1:47 ` [PATCH v2 1/5] MyFirstContribution: add "Anatomy of a Patch Series" section Philippe Blain via GitGitGadget
2022-05-11 6:20 ` Bagas Sanjaya
2022-05-11 21:30 ` Junio C Hamano
2022-05-11 21:48 ` Philippe Blain
2022-05-11 22:09 ` Junio C Hamano
2022-05-12 23:00 ` Philippe Blain
2022-05-12 12:11 ` Philip Oakley
2022-05-12 22:53 ` Philippe Blain
2022-05-11 1:47 ` [PATCH v2 2/5] MyFirstContribution: add standalone section on cover letter Philippe Blain via GitGitGadget
2022-05-11 10:01 ` Junio C Hamano [this message]
2022-05-11 21:49 ` Philippe Blain
2022-05-11 1:47 ` [PATCH v2 3/5] MyFirstContribution: reference "The cover letter" in "Preparing Email" Philippe Blain via GitGitGadget
2022-05-11 1:47 ` [PATCH v2 4/5] MyFirstContribution: reference "The cover letter" in GitGitGadget section Philippe Blain via GitGitGadget
2022-05-11 1:47 ` [PATCH v2 5/5] MyFirstContribution: drop PR description for GGG single-patch contributions Philippe Blain via GitGitGadget
2022-05-11 10:11 ` [PATCH v2 0/5] Improve MyFirstContribution's GitGitGadget section Junio C Hamano
2022-05-11 17:45 ` Victoria Dye
2022-05-12 23:43 ` [PATCH v3 " Philippe Blain via GitGitGadget
2022-05-12 23:43 ` [PATCH v3 1/5] MyFirstContribution: add "Anatomy of a Patch Series" section Philippe Blain via GitGitGadget
2022-05-12 23:43 ` [PATCH v3 2/5] MyFirstContribution: add standalone section on cover letter Philippe Blain via GitGitGadget
2022-05-12 23:43 ` [PATCH v3 3/5] MyFirstContribution: reference "The cover letter" in "Preparing Email" Philippe Blain via GitGitGadget
2022-05-12 23:43 ` [PATCH v3 4/5] MyFirstContribution: reference "The cover letter" in GitGitGadget section Philippe Blain via GitGitGadget
2022-05-12 23:43 ` [PATCH v3 5/5] MyFirstContribution: drop PR description for GGG single-patch contributions Philippe Blain via GitGitGadget
2022-05-19 21:49 ` [PATCH v3 0/5] Improve MyFirstContribution's GitGitGadget section Junio C Hamano
2022-05-21 16:17 ` Philippe Blain
2022-05-22 1:35 ` Junio C Hamano
2022-05-24 12:29 ` Philippe Blain
2022-05-24 19:06 ` Junio C Hamano
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=xmqqa6boo0az.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=Johannes.Schindelin@gmx.de \
--cc=emilyshaffer@google.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=levraiphilippeblain@gmail.com \
--cc=sunshine@sunshineco.com \
--cc=vdye@github.com \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.