MyFirstContribution: update mailing list sub steps

[spectral54]

CC: Konstantin Ryabitsev [email protected]
cc: "Kristoffer Haugsbakk" [email protected]

[gitgitgadget]

Welcome to GitGitGadget

Hi @spectral54, and welcome to GitGitGadget, the GitHub App to send patch series to the Git mailing list from GitHub Pull Requests.

Please make sure that your Pull Request has a good description, as it will be used as cover letter. You can CC potential reviewers by adding a footer to the PR description with the following syntax:

CC: Revi Ewer <[email protected]>, Ill Takalook <[email protected]>

Also, it is a good idea to review the commit messages one last time, as the Git project expects them in a quite specific form:

• the lines should not exceed 76 columns,
• the first line should be like a header and typically start with a prefix like "tests:" or "revisions:" to state which subsystem the change is about, and
• the commit messages' body should be describing the "why?" of the change.
• Finally, the commit messages should end in a Signed-off-by: line matching the commits' author.

It is in general a good idea to await the automated test ("Checks") in this Pull Request before contributing the patches, e.g. to avoid trivial issues such as unportable code.

Contributing the patches

Before you can contribute the patches, your GitHub username needs to be added to the list of permitted users. Any already-permitted user can do that, by adding a comment to your PR of the form /allow. A good way to find other contributors is to locate recent pull requests where someone has been /allowed:

• Search: is:pr is:open "/allow"

Both the person who commented /allow and the PR author are able to /allow you.

An alternative is the channel #git-devel on the Libera Chat IRC network:

<newcontributor> I've just created my first PR, could someone please /allow me? https://github.com/gitgitgadget/git/pull/12345
<veteran> newcontributor: it is done
<newcontributor> thanks!

Once on the list of permitted usernames, you can contribute the patches to the Git mailing list by adding a PR comment /submit.

If you want to see what email(s) would be sent for a /submit request, add a PR comment /preview to have the email(s) sent to you. You must have a public GitHub email address for this. Note that any reviewers CC'd via the list in the PR description will not actually be sent emails.

After you submit, GitGitGadget will respond with another comment that contains the link to the cover letter mail in the Git mailing list archive. Please make sure to monitor the discussion in that thread and to address comments and suggestions (while the comments and suggestions will be mirrored into the PR by GitGitGadget, you will still want to reply via mail).

If you do not want to subscribe to the Git mailing list just to be able to respond to a mail, you can download the mbox from the Git mailing list archive (click the (raw) link), then import it into your mail program. If you use GMail, you can do this via:

curl -g --user "<EMailAddress>:<Password>" \
    --url "imaps://imap.gmail.com/INBOX" -T /path/to/raw.txt

To iterate on your change, i.e. send a revised patch or patch series, you will first want to (force-)push to the same branch. You probably also want to modify your Pull Request description (or title). It is a good idea to summarize the revision by adding something like this to the cover letter (read: by editing the first comment on the PR, i.e. the PR description):

Changes since v1:
- Fixed a typo in the commit message (found by ...)
- Added a code comment to ... as suggested by ...
...

To send a new iteration, just add another PR comment with the contents: /submit.

Need help?

New contributors who want advice are encouraged to join [email protected], where volunteers who regularly contribute to Git are willing to answer newbie questions, give advice, or otherwise provide mentoring to interested contributors. You must join in order to post or view messages, but anyone can join.

You may also be able to find help in real time in the developer IRC channel, #git-devel on Libera Chat. Remember that IRC does not support offline messaging, so if you send someone a private message and log out, they cannot respond to you. The scrollback of #git-devel is archived, though.

[nasamuffin]

/allow

[gitgitgadget]

User spectral54 is now allowed to use GitGitGadget.

WARNING: spectral54 has no public email address set on GitHub;
GitGitGadget needs an email address to Cc: you on your contribution, so that you receive any feedback on the Git mailing list. Go to https://github.com/settings/profile to make your preferred email public to let GitGitGadget know which email address to use.

[spectral54]

/preview

[gitgitgadget]

Preview email sent as [email protected]

[spectral54]

/submit

[gitgitgadget]

Submitted as [email protected]

To fetch this version into FETCH_HEAD:

git fetch https://github.com/gitgitgadget/git/ pr-1644/spectral54/my-first-contribution-v1

To fetch this version to local tag pr-1644/spectral54/my-first-contribution-v1:

git fetch --no-tags https://github.com/gitgitgadget/git/ tag pr-1644/spectral54/my-first-contribution-v1

[gitgitgadget]

On the Git mailing list, Konstantin Ryabitsev wrote (reply to this):

On Fri, Jan 19, 2024 at 08:59:15PM +0000, spectral via GitGitGadget wrote:
>  contributing are welcome to post questions here. The Git list requires
>  plain-text-only emails and prefers inline and bottom-posting when replying to
>  mail; you will be CC'd in all replies to you. Optionally, you can subscribe to
> -the list by sending an email to [email protected] with "subscribe git"
> -in the body. The https://lore.kernel.org/git[archive] of this mailing list is
> -available to view in a browser.
> +the list by visiting https://subspace.kernel.org/vger.kernel.org.html and using
> +the `sub` link next to the `git` list (this is a mailto link; you can leave
> +subject and body blank, but you still have to send the email). The

I recommend just telling people to send a message to
[email protected] and linking to
https://subspace.kernel.org/subscribing.html for more details. While
"sub/unsub" links will do the job for some people, webmail users may not
have things properly configured to correctly process the mailto: links.

-K

[gitgitgadget]

On the Git mailing list, Junio C Hamano wrote (reply to this):

Konstantin Ryabitsev <[email protected]> writes:

> On Fri, Jan 19, 2024 at 08:59:15PM +0000, spectral via GitGitGadget wrote:
>>  contributing are welcome to post questions here. The Git list requires
>>  plain-text-only emails and prefers inline and bottom-posting when replying to
>>  mail; you will be CC'd in all replies to you. Optionally, you can subscribe to
>> -the list by sending an email to [email protected] with "subscribe git"
>> -in the body. The https://lore.kernel.org/git[archive] of this mailing list is
>> -available to view in a browser.
>> +the list by visiting https://subspace.kernel.org/vger.kernel.org.html and using
>> +the `sub` link next to the `git` list (this is a mailto link; you can leave
>> +subject and body blank, but you still have to send the email). The
>
> I recommend just telling people to send a message to
> [email protected] and linking to
> https://subspace.kernel.org/subscribing.html for more details. While
> "sub/unsub" links will do the job for some people, webmail users may not
> have things properly configured to correctly process the mailto: links.

Yeah, good suggestion.

Kyle, thanks for noticing the majordomo deprecation.

Perhaps something like this is agreeable to everybody?

------------ >8 ----------------------- >8 ----------------------- >8 ------------
Subject: Docs: [email protected] has been decomissioned

Update the instruction for subscribing to the Git mailing list
we have on a few documentation pages.

Noticed-by: Kyle Lippincott <[email protected]>
Helped-by: Konstantin Ryabitsev <[email protected]>
Signed-off-by: Junio C Hamano <[email protected]>
---
 Documentation/MyFirstContribution.txt | 5 +++--
 README.md                             | 4 ++--
 2 files changed, 5 insertions(+), 4 deletions(-)

diff --git c/Documentation/MyFirstContribution.txt w/Documentation/MyFirstContribution.txt
index 279f6a3e7c..f06563e981 100644
--- c/Documentation/MyFirstContribution.txt
+++ w/Documentation/MyFirstContribution.txt
@@ -35,8 +35,9 @@ announcements, design discussions, and more take place. Those interested in
 contributing are welcome to post questions here. The Git list requires
 plain-text-only emails and prefers inline and bottom-posting when replying to
 mail; you will be CC'd in all replies to you. Optionally, you can subscribe to
-the list by sending an email to [email protected] with "subscribe git"
-in the body. The https://lore.kernel.org/git[archive] of this mailing list is
+the list by sending an email to <[email protected]>
+(see https://subspace.kernel.org/subscribing.html for details).
+The https://lore.kernel.org/git[archive] of this mailing list is
 available to view in a browser.
 
 ==== https://groups.google.com/forum/#!forum/git-mentoring[[email protected]]
diff --git c/README.md w/README.md
index 2c3de2f9c8..665ce5f5a8 100644
--- c/README.md
+++ w/README.md
@@ -39,8 +39,8 @@ Those wishing to help with error message, usage and informational message
 string translations (localization l10) should see [po/README.md][]
 (a `po` file is a Portable Object file that holds the translations).
 
-To subscribe to the list, send an email with just "subscribe git" in
-the body to [email protected] (not the Git list). The mailing
+To subscribe to the list, send an email to <[email protected]>
+(see https://subspace.kernel.org/subscribing.html for details). The mailing
 list archives are available at <https://lore.kernel.org/git/>,
 <https://marc.info/?l=git> and other archival sites.
 

[gitgitgadget]

On the Git mailing list, Kyle Lippincott wrote (reply to this):

On Fri, Jan 19, 2024 at 2:26 PM Junio C Hamano <[email protected]> wrote:
> Subject: Docs: [email protected] has been decomissioned
>
> Update the instruction for subscribing to the Git mailing list
> we have on a few documentation pages.
>
> Noticed-by: Kyle Lippincott <[email protected]>
> Helped-by: Konstantin Ryabitsev <[email protected]>
> Signed-off-by: Junio C Hamano <[email protected]>
> ---
>  Documentation/MyFirstContribution.txt | 5 +++--
>  README.md                             | 4 ++--
>  2 files changed, 5 insertions(+), 4 deletions(-)

This version looks good, thanks for catching README.md's reference as well.

[gitgitgadget]

On the Git mailing list, "Kristoffer Haugsbakk" wrote (reply to this):

On Fri, Jan 19, 2024, at 23:26, Junio C Hamano wrote:
> Noticed-by: Kyle Lippincott <[email protected]>
> Helped-by: Konstantin Ryabitsev <[email protected]>
> Signed-off-by: Junio C Hamano <[email protected]>

Just curious. What’s the difference between `Reported-by` and
`Noticed-by`? `Reported-by` is documented in `SubmittingPatches` but not
the other one. Is perhaps `Reported-by` specifically meant for bug
reports?

Thanks

-- 
Kristoffer Haugsbakk

[gitgitgadget]

User "Kristoffer Haugsbakk" <[email protected]> has been added to the cc: list.

[gitgitgadget]

On the Git mailing list, Junio C Hamano wrote (reply to this):

"Kristoffer Haugsbakk" <[email protected]> writes:

> Just curious. What’s the difference between `Reported-by` and
> `Noticed-by`? `Reported-by` is documented in `SubmittingPatches` but not
> the other one. Is perhaps `Reported-by` specifically meant for bug
> reports?

It should be reported-by as the recent trend is to dedup similar
ones without much meaningful distinction and stick to those that are
listed in the document.  It was just me being careless and picked
one that used to be relatively common without even thinking:

 $ git rev-list --since 1.year --grep=Noticed-by: --count master
 2
 $ git rev-list --since 1.year --grep=Reported-by: --count master
 54

 $ git rev-list --since 5.year --until 4.year --grep=Noticed-by: --count master
 4
 $ git rev-list --since 5.year --until 4.year --grep=Reported-by: --count master
 102

 $ git rev-list --since 10.year --until 9.year --grep=Noticed-by: --count master
 12
 $ git rev-list --since 10.year --until 9.year --grep=Reported-by: --count master
 54

There probably is a subtle difference perceived between the two by
those who used noticed-by over the years and I think you guessed
their intention right.