From: "Philippe Blain via GitGitGadget" <gitgitgadget@gmail.com> To: git@vger.kernel.org Cc: Emily Shaffer <emilyshaffer@google.com>, Johannes Schindelin <Johannes.Schindelin@gmx.de>, Philippe Blain <levraiphilippeblain@gmail.com>, Philippe Blain <levraiphilippeblain@gmail.com> Subject: [PATCH 1/3] MyFirstContribution: move cover letter description to a separate file Date: Wed, 27 Apr 2022 19:04:46 +0000 [thread overview] Message-ID: <7e84d5b286de9dddf28ef1c8f38c7d7c28e266f0.1651086288.git.gitgitgadget@gmail.com> (raw) In-Reply-To: <pull.1226.git.1651086288.gitgitgadget@gmail.com> From: Philippe Blain <levraiphilippeblain@gmail.com> In a subsequent commit we want to reuse the explanation of the purpose of The cover letter form the "Sending Patches with git send-email" section in the "Sending Patches via GitGitGadget" section. To avoid text duplication, move this explanation to a separate file and include it in MyFirstContribution.txt. Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com> --- .../MyFirstContribution-coverletter.txt | 18 ++++++++++++++++ Documentation/MyFirstContribution.txt | 21 ++----------------- 2 files changed, 20 insertions(+), 19 deletions(-) create mode 100644 Documentation/MyFirstContribution-coverletter.txt diff --git a/Documentation/MyFirstContribution-coverletter.txt b/Documentation/MyFirstContribution-coverletter.txt new file mode 100644 index 00000000000..b9e1e10427a --- /dev/null +++ b/Documentation/MyFirstContribution-coverletter.txt @@ -0,0 +1,18 @@ +This is an important component of change submission as it explains to the +community from a high level 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. +---- diff --git a/Documentation/MyFirstContribution.txt b/Documentation/MyFirstContribution.txt index 63a2ef54493..681bbefe9cd 100644 --- a/Documentation/MyFirstContribution.txt +++ b/Documentation/MyFirstContribution.txt @@ -976,25 +976,8 @@ filter their email for this type of flag. You'll need to add some extra parameters when you invoke `git send-email` to add the cover letter. -Next you'll have to fill out the body of your cover letter. This is an important -component of change submission as it explains to the community from a high level -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. ----- +Next you'll have to fill out the body of your cover letter. +include::MyFirstContribution-coverletter.txt[] 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. -- gitgitgadget
next prev parent reply other threads:[~2022-04-27 19:13 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 ` Philippe Blain via GitGitGadget [this message] 2022-04-27 21:15 ` [PATCH 1/3] MyFirstContribution: move cover letter description to a separate file 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 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 List information: http://vger.kernel.org/majordomo-info.html * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=7e84d5b286de9dddf28ef1c8f38c7d7c28e266f0.1651086288.git.gitgitgadget@gmail.com \ --to=gitgitgadget@gmail.com \ --cc=Johannes.Schindelin@gmx.de \ --cc=emilyshaffer@google.com \ --cc=git@vger.kernel.org \ --cc=levraiphilippeblain@gmail.com \ --subject='Re: [PATCH 1/3] MyFirstContribution: move cover letter description to a separate file' \ /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
Code repositories for project(s) associated with this inbox: https://80x24.org/mirrors/git.git This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).