diff mbox series

[v3,1/8] MyFirstContribution: mention contrib/contacts/git-contacts

Message ID 1f65dc5ba3ded5b90ed929aa3884574e8b26cd9b.1712699815.git.gitgitgadget@gmail.com (mailing list archive)
State Superseded
Headers show
Series docs: recommend using contrib/contacts/git-contacts | expand

Commit Message

Linus Arver April 9, 2024, 9:56 p.m. UTC
From: Linus Arver <linusa@google.com>

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 <linusa@google.com>
---
 Documentation/MyFirstContribution.txt | 5 +++++
 1 file changed, 5 insertions(+)

Comments

Linus Arver April 9, 2024, 10:20 p.m. UTC | #1
"Linus Arver via GitGitGadget" <gitgitgadget@gmail.com> writes:

> From: Linus Arver <linusa@google.com>
>
> 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 <linusa@google.com>
> ---
>  Documentation/MyFirstContribution.txt | 5 +++++
>  1 file changed, 5 insertions(+)
>
> diff --git a/Documentation/MyFirstContribution.txt b/Documentation/MyFirstContribution.txt
> index f06563e9817..00f4c63cb9f 100644
> --- a/Documentation/MyFirstContribution.txt
> +++ b/Documentation/MyFirstContribution.txt
> @@ -1116,6 +1116,11 @@ $ 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: If you're not sure who to CC, use `contrib/contacts/git-contacts` to get a
> +list of reviewers you should include in the CC list. In addition, you can do

I just realized that I could also do s/should/could here, but I assume
you'd prefer to modify in-place instead of me rerolling for a v4 just
for this change. Thanks.
Junio C Hamano April 9, 2024, 11:02 p.m. UTC | #2
Linus Arver <linusa@google.com> writes:

>> +NOTE: If you're not sure who to CC, use `contrib/contacts/git-contacts` to get a
>> +list of reviewers you should include in the CC list. In addition, you can do
>
> I just realized that I could also do s/should/could here, but I assume
> you'd prefer to modify in-place instead of me rerolling for a v4 just
> for this change. Thanks.

We do not even know if there are other things people find issues
with in this iteration, so it is a bit too early to say that.  In a
case like this, if you do not feel so strongly about it (which I am
guessing from your "I could also") either way, staying mum would
probably be the best.  If you feel more strongly than that, saying
"I plan to update 'should' -> 'could' if I end up doing v4" right
now would be fine.  Then when there are other things you'd need to
update after waiting for others' input, you could keep that promise.
If there are no other things you'd want to update after waiting,
that would be the good time to say "Here is a fixup! commit; squash
into topic X. There is no other changes".

For now, I inserted this extra commit between [1/8] and [2/8].
Thanks.

diff --git a/Documentation/MyFirstContribution.txt b/Documentation/MyFirstContribution.txt
index 00f4c63cb9..bb7e4174e8 100644
--- a/Documentation/MyFirstContribution.txt
+++ b/Documentation/MyFirstContribution.txt
@@ -1116,8 +1116,8 @@ $ 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: If you're not sure who to CC, use `contrib/contacts/git-contacts` to get a
-list of reviewers you should include in the CC list. In addition, you can do
+NOTE: If you're not sure whom to CC, running `contrib/contacts/git-contacts`
+can list potential reviewers to put on the CC list. In addition, you can do
 `git send-email --cc-cmd='git contacts' feature/*.patch` to automatically pass
 this list of emails to `send-email`.
Linus Arver April 9, 2024, 11:42 p.m. UTC | #3
Junio C Hamano <gitster@pobox.com> writes:

> Linus Arver <linusa@google.com> writes:
>
>>> +NOTE: If you're not sure who to CC, use `contrib/contacts/git-contacts` to get a
>>> +list of reviewers you should include in the CC list. In addition, you can do
>>
>> I just realized that I could also do s/should/could here, but I assume
>> you'd prefer to modify in-place instead of me rerolling for a v4 just
>> for this change. Thanks.
>
> We do not even know if there are other things people find issues
> with in this iteration, so it is a bit too early to say that.

True.

FTR I should have added "I don't want to reroll this right now so soon
to correct just this error, seems a bit premature" because that's what I
meant to convey.

> In a
> case like this, if you do not feel so strongly about it (which I am
> guessing from your "I could also") either way, staying mum would
> probably be the best.

Ack.

> If you feel more strongly than that, saying
> "I plan to update 'should' -> 'could' if I end up doing v4" right
> now would be fine.

In hindsight this is what I shoould have said.

> Then when there are other things you'd need to
> update after waiting for others' input, you could keep that promise.
> If there are no other things you'd want to update after waiting,
> that would be the good time to say "Here is a fixup! commit; squash
> into topic X. There is no other changes".

Makes sense, thanks. I need to set up `send-email` so that I can start
sending individual patches like in your hypothetical scenario (I don't
know how to do that with GGG, or if it is even possible).

> For now, I inserted this extra commit between [1/8] and [2/8].
> Thanks.
>
> diff --git a/Documentation/MyFirstContribution.txt b/Documentation/MyFirstContribution.txt
> index 00f4c63cb9..bb7e4174e8 100644
> --- a/Documentation/MyFirstContribution.txt
> +++ b/Documentation/MyFirstContribution.txt
> @@ -1116,8 +1116,8 @@ $ 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: If you're not sure who to CC, use `contrib/contacts/git-contacts` to get a
> -list of reviewers you should include in the CC list. In addition, you can do
> +NOTE: If you're not sure whom to CC, running `contrib/contacts/git-contacts`
> +can list potential reviewers to put on the CC list. In addition, you can do

Nice. I think you can also remove the trailing "to put on the CC list"
clause because it's somewehat redundant.
Linus Arver April 11, 2024, 10:53 p.m. UTC | #4
Linus Arver <linusa@google.com> writes:

> Junio C Hamano <gitster@pobox.com> writes:
> [...]
>> For now, I inserted this extra commit between [1/8] and [2/8].
>> Thanks.
>>
>> diff --git a/Documentation/MyFirstContribution.txt b/Documentation/MyFirstContribution.txt
>> index 00f4c63cb9..bb7e4174e8 100644
>> --- a/Documentation/MyFirstContribution.txt
>> +++ b/Documentation/MyFirstContribution.txt
>> @@ -1116,8 +1116,8 @@ $ 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: If you're not sure who to CC, use `contrib/contacts/git-contacts` to get a
>> -list of reviewers you should include in the CC list. In addition, you can do
>> +NOTE: If you're not sure whom to CC, running `contrib/contacts/git-contacts`
>> +can list potential reviewers to put on the CC list. In addition, you can do
>
> Nice. I think you can also remove the trailing "to put on the CC list"
> clause because it's somewehat redundant.

I will incorporate this into the next reroll.
diff mbox series

Patch

diff --git a/Documentation/MyFirstContribution.txt b/Documentation/MyFirstContribution.txt
index f06563e9817..00f4c63cb9f 100644
--- a/Documentation/MyFirstContribution.txt
+++ b/Documentation/MyFirstContribution.txt
@@ -1116,6 +1116,11 @@  $ 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: If you're not sure who to CC, use `contrib/contacts/git-contacts` to get a
+list of reviewers you should include in the CC list. In addition, you can do
+`git send-email --cc-cmd='git contacts' feature/*.patch` to automatically pass
+this list of emails to `send-email`.
+
 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.