git@vger.kernel.org list mirror (unofficial, one of many)
 help / color / mirror / code / Atom feed
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>,
	Victoria Dye <vdye@github.com>,
	Eric Sunshine <sunshine@sunshineco.com>,
	Philippe Blain <levraiphilippeblain@gmail.com>,
	Bagas Sanjaya <bagasdotme@gmail.com>,
	Philip Oakley <philipoakley@iee.email>,
	Philippe Blain <levraiphilippeblain@gmail.com>
Subject: [PATCH v3 0/5] Improve MyFirstContribution's GitGitGadget section
Date: Thu, 12 May 2022 23:43:32 +0000	[thread overview]
Message-ID: <pull.1226.v3.git.1652399017.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.1226.v2.git.1652233654.gitgitgadget@gmail.com>

Changes since v2:

 * tweaked 2/5 following Junio's comments (added more details, tweaked the
   wording and added a note about single patch series).

v2: Thanks a lot for the reviews! Here is an updated version.

Changes since v1:

 * Based on v1 feedback, instead of reusing the 'git send-email' content
   verbatim in the GGG section, added a new section and reference it in both
   'git send-email' and GGG sections. (patches 1/5-4/5)
 * In patch 5/5 (patch 3/3 in v1), tweak wording and add a reference to the
   "Bonus Chapter: One-Patch Changes" section.

v1: Two small improvements to the MyFirstContribution tutorial:

 * Describe the purpose of the cover letter in that section also, and give
   an example just as in the 'git send-email' section
 * Instruct contributors to drop the GitHub-generated PR description for
   single patch contributions.

Philippe Blain (5):
  MyFirstContribution: add "Anatomy of a Patch Series" section
  MyFirstContribution: add standalone section on cover letter
  MyFirstContribution: reference "The cover letter" in "Preparing Email"
  MyFirstContribution: reference "The cover letter" in GitGitGadget
    section
  MyFirstContribution: drop PR description for GGG single-patch
    contributions

 Documentation/MyFirstContribution.txt | 155 ++++++++++++++++++++------
 1 file changed, 120 insertions(+), 35 deletions(-)


base-commit: 6cd33dceed60949e2dbc32e3f0f5e67c4c882e1e
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1226%2Fphil-blain%2Fmyfirst-contrib-single-patch-ggg-v3
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1226/phil-blain/myfirst-contrib-single-patch-ggg-v3
Pull-Request: https://github.com/gitgitgadget/git/pull/1226

Range-diff vs v2:

 1:  59af7e5e5ad = 1:  59af7e5e5ad MyFirstContribution: add "Anatomy of a Patch Series" section
 2:  9552d80a80d ! 2:  ee3238f5a91 MyFirstContribution: add standalone section on cover letter
     @@ Commit message
      
       ## Documentation/MyFirstContribution.txt ##
      @@ Documentation/MyFirstContribution.txt: We can note a few things:
     -   v3]", etc. and sent with a new cover letter, itself a reply to the cover
     -   letter of the previous iteration (more on that below).
     - 
     +   _n_-commit series.
     + - Each patch is sent as a reply to an introductory email called the _cover
     +   letter_ of the series, prefixed "[PATCH 0/_n_]".
     +-- Subsequent iterations of the patch series are labelled "[PATCH v2]", "[PATCH
     +-  v3]", etc. and sent with a new cover letter, itself a reply to the cover
     +-  letter of the previous iteration (more on that below).
     ++- Subsequent iterations of the patch series are labelled "PATCH v2", "PATCH
     ++  v3", etc. in place of "PATCH". For example, "[PATCH v2 1/3]" would be the first of
     ++  three patches in the second iteration. Each iteration is sent with a new cover
     ++  letter (like "[PATCH v2 0/3]" above), itself a reply to the cover letter of the
     ++  previous iteration (more on that below).
     ++
     ++NOTE: A single-patch topic is sent with "[PATCH]", "[PATCH v2]", etc. without
     ++_i_/_n_ numbering (in the above thread overview, no single-patch topic appears,
     ++though).
     ++
      +[[cover-letter]]
      +=== The cover letter
      +
     @@ Documentation/MyFirstContribution.txt: We can note a few things:
      +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.
     ++should also be in your commit messages.
      +
      +Here's an example body for `psuh`:
      +
     @@ Documentation/MyFirstContribution.txt: We can note a few things:
      +This patchset is part of the MyFirstContribution tutorial and should not
      +be merged.
      +----
     -+
     + 
       At this point the tutorial diverges, in order to demonstrate two
       different methods of formatting your patchset and getting it reviewed.
     - 
      @@ Documentation/MyFirstContribution.txt: but want reviewers to look at what they have so far. You can add this flag with
       Check and make sure that your patches and cover letter template exist in the
       directory you specified - you're nearly ready to send out your review!
 3:  d7699289ea6 = 3:  2caec6e619a MyFirstContribution: reference "The cover letter" in "Preparing Email"
 4:  f6034b0964b = 4:  02598d431e0 MyFirstContribution: reference "The cover letter" in GitGitGadget section
 5:  33256c6b4ba = 5:  76bcb6612e4 MyFirstContribution: drop PR description for GGG single-patch contributions

-- 
gitgitgadget

  parent reply	other threads:[~2022-05-12 23:44 UTC|newest]

Thread overview: 43+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-04-27 19:04 [PATCH 0/3] " 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
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   ` Philippe Blain via GitGitGadget [this message]
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=pull.1226.v3.git.1652399017.gitgitgadget@gmail.com \
    --to=gitgitgadget@gmail.com \
    --cc=Johannes.Schindelin@gmx.de \
    --cc=bagasdotme@gmail.com \
    --cc=emilyshaffer@google.com \
    --cc=git@vger.kernel.org \
    --cc=levraiphilippeblain@gmail.com \
    --cc=philipoakley@iee.email \
    --cc=sunshine@sunshineco.com \
    --cc=vdye@github.com \
    --subject='Re: [PATCH v3 0/5] Improve MyFirstContribution'\''s GitGitGadget section' \
    /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).