From: Matthias Aßhauer Date: Wed, 03 Apr 2024 08:42:58 GMT Subject: Re: [PATCH] docs: recommend using contrib/contacts/git-contacts Message-ID: In-Reply-To: On Tue, 2 Apr 2024, Linus Arver via GitGitGadget wrote: > From: Linus Arver > > Although we've had this script since 4d06402b1b (contrib: add > git-contacts helper, 2013-07-21), we don't mention it in our > introductory docs. Do so now. > > Signed-off-by: Linus Arver > --- > docs: recommend using contrib/contacts/git-contacts > > Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1704%2Flistx%2Freviewers-v1 > Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1704/listx/reviewers-v1 > Pull-Request: https://github.com/gitgitgadget/git/pull/1704 > > Documentation/MyFirstContribution.txt | 3 +++ > Documentation/SubmittingPatches | 4 ++++ > 2 files changed, 7 insertions(+) > > diff --git a/Documentation/MyFirstContribution.txt b/Documentation/MyFirstContribution.txt > index f06563e9817..eb1e27a82df 100644 > --- a/Documentation/MyFirstContribution.txt > +++ b/Documentation/MyFirstContribution.txt > @@ -1116,6 +1116,9 @@ $ git send-email --to=target@example.com psuh/*.patch > NOTE: Check `git help send-email` for some other options which you may find > valuable, such as changing the Reply-to address or adding more CC and BCC lines. > > +NOTE: Use `contrib/contacts/git-contacts` to get a list of reviewers you should > +include in the CC list. > + > NOTE: When you are sending a real patch, it will go to git@vger.kernel.org - but > please don't send your patchset from the tutorial to the real mailing list! For > now, you can send it to yourself, to make sure you understand how it will look. > diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches > index e734a3f0f17..52d11ff510b 100644 > --- a/Documentation/SubmittingPatches > +++ b/Documentation/SubmittingPatches > @@ -459,6 +459,10 @@ an explanation of changes between each iteration can be kept in > Git-notes and inserted automatically following the three-dash > line via `git format-patch --notes`. > > +[[suggested-reviewers]] > +Use `contrib/contacts/git-contacts` to get a list of reviewers you should > +include in the CC list. > + There is already a paragraph about this in Documentation/SubmittingPatches just a few paragraphs below. > Send your patch with "To:" set to the mailing list, with "cc:" listing > people who are involved in the area you are touching (the `git > contacts` command in `contrib/contacts/` can help to > identify them), to solicit comments and reviews. Also, when you made > trial merges of your topic to `next` and `seen`, you may have noticed > work by others conflicting with your changes. There is a good possibility > that these people may know the area you are touching well. Could we improve the existing paragraph instead of duplicating this information? > [[attachment]] > Do not attach the patch as a MIME attachment, compressed or not. > Do not let your e-mail client send quoted-printable. Do not let > > base-commit: c2cbfbd2e28cbe27c194d62183b42f27a6a5bb87 > -- > gitgitgadget >