Re: [PATCH] Documentation/MyFirstContribution: add setup template for git send-email

From: Vivan Garg <v.garg.work@gmail.com>
Date: Feb 23, 2023, 04:09 UTC
Message-ID: <CADupsJNVV+GqV9+On6rWiDfVE4ryCvtwzcLAN_GuDcysKXyACQ@mail.gmail.com>
In-Reply-To: <a6b0cf3b-af44-3d35-3de1-62aaf65f1543@github.com>

> It's generally good practice to CC contributors that have been recently
> and/or heavily involved in the code you're changing. Given that, I've CC'd
> Emily Shaffer (original author of the doc, including the section you'd like
> to change).

I see, will do in the future.

> Earlier commits related to this file start with just "MyFirstContribution:",
> so you can leave out the "Documentation/" prefix to stay under the 50
> character width.

Noted.

Show 6 quoted lines

> The section you're replacing explicitly states that providing example
> configuration is out of scope for this document. That's for good reason; the
> example config you've provided isn't universal to all developer setups. It
> would be more confusing to a new contributor if we recommended a config
> that's incompatible with their setup than if we left it open-ended as it is
> now.

Oh, I thought you had to set these parameters, i.e. smtpServer, smtpServerPort, smtpEncryption, smtpUser, and smtpPass in gitConfig regardless of the setup (I did some googling as well). However, I'll take your word for it that it may be incompatible with some setups. Thanks for pointing that out!

> However, if you still want to make the guidance in this section more
> specific, you could add a 'linkgit:git-config' link and note that the
> relevant SMTP configs are under the 'sendemail' section.

That sounds like a good addition! I'll do it then. Thanks!