threads / patch / 48269

patchSubmittingPatches: mention the git contacts command

Subject: [PATCH resend] SubmittingPatches: mention the git contacts command

## tl;dr

3 messages between Apr 11, 2018 and Apr 11, 2018. Diffs are folded; open one to read it.

replies: 2people: 3as markdown or json

Thomas Gummerer· Apr 11, 2018, 20:20 UTC · lore

Instead of just mentioning 'git blame' and 'git shortlog', which make it quite hard for new contributors to pick out the appropriate list of people to cc on their patch series, mention the 'git contacts' utility, which makes it much easier to get a reasonable list of contacts for a change.

This should help new contributors pick out a reasonable cc list by simply using a single command.

Signed-off-by: Thomas Gummerer <t.gummerer@gmail.com>
---

I've originally sent this at <20180316213323.GC2224@hank>, during an the rc period. Eric had some comments, which I interpreted as being okay with the change (hope I'm not mistaken there :)). As I still think this would be an improvement for new contributors, I'm resending it here.

 Documentation/SubmittingPatches | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Show changes to Documentation/SubmittingPatches +2 −2

diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index a1d0feca36..945f8edb46 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -260,8 +260,8 @@ that starts with `-----BEGIN PGP SIGNED MESSAGE-----`.  That is
 not a text/plain, it's something else.
 
 Send your patch with "To:" set to the mailing list, with "cc:" listing
-people who are involved in the area you are touching (the output from
-`git blame $path` and `git shortlog --no-merges $path` would help to
+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.
 
 :1: footnote:[The current maintainer: gitster@pobox.com]

-- 
2.16.2.804.g6dcf76e11

Derrick Stolee· Apr 11, 2018, 20:38 UTC · re: Thomas Gummerer · lore

Re: [PATCH resend] SubmittingPatches: mention the git contacts command

On 4/11/2018 4:20 PM, Thomas Gummerer wrote:

Show 17 quoted lines

> Instead of just mentioning 'git blame' and 'git shortlog', which make it
> quite hard for new contributors to pick out the appropriate list of
> people to cc on their patch series, mention the 'git contacts' utility,
> which makes it much easier to get a reasonable list of contacts for a
> change.
>
> This should help new contributors pick out a reasonable cc list by
> simply using a single command.
>
> Signed-off-by: Thomas Gummerer <t.gummerer@gmail.com>
> ---
>
> I've originally sent this at <20180316213323.GC2224@hank>, during an
> the rc period.  Eric had some comments, which I interpreted as being
> okay with the change (hope I'm not mistaken there :)).  As I still
> think this would be an improvement for new contributors, I'm resending
> it here.

I didn't know about this tool, and it seems helpful. I plan to use it now. Thanks!

Show 18 quoted lines

>   Documentation/SubmittingPatches | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
> index a1d0feca36..945f8edb46 100644
> --- a/Documentation/SubmittingPatches
> +++ b/Documentation/SubmittingPatches
> @@ -260,8 +260,8 @@ that starts with `-----BEGIN PGP SIGNED MESSAGE-----`.  That is
>   not a text/plain, it's something else.
>   
>   Send your patch with "To:" set to the mailing list, with "cc:" listing
> -people who are involved in the area you are touching (the output from
> -`git blame $path` and `git shortlog --no-merges $path` would help to
> +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.
>   
>   :1: footnote:[The current maintainer: gitster@pobox.com]

Eric Sunshine· Apr 11, 2018, 20:42 UTC · re: Thomas Gummerer · lore

Re: [PATCH resend] SubmittingPatches: mention the git contacts command

On Wed, Apr 11, 2018 at 4:20 PM, Thomas Gummerer <t.gummerer@gmail.com> wrote:

Show 17 quoted lines

> Instead of just mentioning 'git blame' and 'git shortlog', which make it
> quite hard for new contributors to pick out the appropriate list of
> people to cc on their patch series, mention the 'git contacts' utility,
> which makes it much easier to get a reasonable list of contacts for a
> change.
>
> This should help new contributors pick out a reasonable cc list by
> simply using a single command.
>
> Signed-off-by: Thomas Gummerer <t.gummerer@gmail.com>
> ---
>
> I've originally sent this at <20180316213323.GC2224@hank>, during an
> the rc period.  Eric had some comments, which I interpreted as being
> okay with the change (hope I'm not mistaken there :)).  As I still
> think this would be an improvement for new contributors, I'm resending
> it here.

I don't think you misinterpreted my response. Your answers to my review questions seemed satisfactory, so I wasn't expecting any changes.