[PATCH 1/3] MyFirstContribution: move cover letter description to a separate file

From

Philippe Blain via GitGitGadget <gitgitgadget@gmail.com>

Date

Apr 27, 2022, 19:04 UTC

Message-ID

<7e84d5b286de9dddf28ef1c8f38c7d7c28e266f0.1651086288.git.gitgitgadget@gmail.com>

In-Reply-To

<pull.1226.git.1651086288.gitgitgadget@gmail.com>

From: Philippe Blain <levraiphilippeblain@gmail.com>

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