[v5] MyFirstContribution: add avenues for getting help
diff mbox series

Message ID 20200124200915.249473-1-emilyshaffer@google.com
State New
Headers show
Series
  • [v5] MyFirstContribution: add avenues for getting help
Related show

Commit Message

Emily Shaffer Jan. 24, 2020, 8:09 p.m. UTC
From: Emily Shaffer <emilyshaffer@google.com>

With https://lore.kernel.org/git/20191114194708.GD60198@google.com/ we
now have a mentoring mailing list, to which we should direct new
contributors who have questions.

Mention #git-devel, which is targeted for Git contributors; asking for
help with getting a first contribution together is on-topic for that
channel. Also mention some of the conventions in case folks are
unfamiliar with IRC.

Because the mentoring list and #git-devel are both a subset of Git
contributors, finally list the main Git list and mention some of the
posting conventions.

Signed-off-by: Emily Shaffer <emilyshaffer@google.com>
---
On v3, Junio mentioned changing the justification for suggesting
#git-devel in the commit-message. Stolee mentioned a missed reference to
public-inbox.org which was fixed in v4, but I mangled the threading, so
I'll also move this one to reply to v3 instead of the
in-thread-with-Stolee v4.

 - Emily

 Documentation/MyFirstContribution.txt | 32 +++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

Comments

Junio C Hamano Jan. 24, 2020, 8:35 p.m. UTC | #1
emilyshaffer@google.com writes:

> From: Emily Shaffer <emilyshaffer@google.com>

Hmm, unlike folks who use GGG, your From: address seem almost usable
without having to waste two extra lines (which matters when one has
to review many patches a day).

> With https://lore.kernel.org/git/20191114194708.GD60198@google.com/ we
> now have a mentoring mailing list, to which we should direct new
> contributors who have questions.

Yay.

> Mention #git-devel, which is targeted for Git contributors; asking for
> help with getting a first contribution together is on-topic for that
> channel. Also mention some of the conventions in case folks are
> unfamiliar with IRC.
>
> Because the mentoring list and #git-devel are both a subset of Git
> contributors, finally list the main Git list and mention some of the
> posting conventions.

> +[[getting-help]]
> +=== Getting Help
> +
> +If you get stuck, you can seek help in the following places.
> +
> +==== https://groups.google.com/forum/#!forum/git-mentoring[git-mentoring@googlegroups.com]
> +
> +This mailing list is targeted to new contributors and is a great place to post
> +questions and receive kind, detailed answers from volunteers on the Git
> +project. You must join the group to view messages or post.

OK.


> +==== https://webchat.freenode.net/#git-devel[#git-devel] on Freenode
> +
> +This IRC channel is for conversations between Git contributors. If someone is
> +currently online and knows the answer to your question, you can receive help
> +in real time. Otherwise, you can read the
> +https://colabti.org/irclogger/irclogger_logs/git-devel[scrollback] to see
> +whether someone answered you. IRC does not allow offline private messaging, so
> +if you try to private message someone and then log out of IRC, they cannot
> +respond to you. It's better to ask your questions in the channel so that you
> +can be answered if you disconnect and so that others can learn from the
> +conversation.

OK.

> +==== https://lore.kernel.org/git[git@vger.kernel.org]

Hmph.  I would have expected mailto:git@vger.kernel.org as the main
URL here, as this enumeration is not for those who lurk to passibly
receive information, but for those (new) contributors who want to
ask help by actively transmitting.  Mentioning lore as an archive
when talking about the list is necessary, but it shouldn't obscure
the main e-mail address people need to know in order to send their
requests.

> +
> +This is the main Git project mailing list where code reviews, version
> +announcements, design discussions, and more take place. 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 majordomo@vger.kernel.org with
> +"subscribe git" in the body.

Thanks.
Emily Shaffer Jan. 24, 2020, 8:50 p.m. UTC | #2
On Fri, Jan 24, 2020 at 12:35:28PM -0800, Junio C Hamano wrote:
> emilyshaffer@google.com writes:
> 
> > From: Emily Shaffer <emilyshaffer@google.com>
> 
> Hmm, unlike folks who use GGG, your From: address seem almost usable
> without having to waste two extra lines (which matters when one has
> to review many patches a day).

Blame an unhealthy appreciation for being able to write emails in Vim.

I generate patches with 'git format-patch' - what's the unusable part of
"almost" usable here? Typically I invoke it like so:

  git format-patch -o ~/mailed-patches/blah -vN master..branchname
  git send-email --to=git@vger.kernel.org ~/mailed-patches/blah/vN*

If there's more tweaking I should do in the workflow I'd like to know.

> > +==== https://lore.kernel.org/git[git@vger.kernel.org]
> 
> Hmph.  I would have expected mailto:git@vger.kernel.org as the main
> URL here, as this enumeration is not for those who lurk to passibly
> receive information, but for those (new) contributors who want to
> ask help by actively transmitting.  Mentioning lore as an archive
> when talking about the list is necessary, but it shouldn't obscure
> the main e-mail address people need to know in order to send their
> requests.

Ok. My personal bias as a long-time browser-as-primary-mail-client user
leaked through. I'll send another revision now.
Emily Shaffer Jan. 24, 2020, 8:54 p.m. UTC | #3
On Fri, Jan 24, 2020 at 12:50:25PM -0800, Emily Shaffer wrote:
> On Fri, Jan 24, 2020 at 12:35:28PM -0800, Junio C Hamano wrote:
> > emilyshaffer@google.com writes:
> > 
> > > From: Emily Shaffer <emilyshaffer@google.com>
> > 
> > Hmm, unlike folks who use GGG, your From: address seem almost usable
> > without having to waste two extra lines (which matters when one has
> > to review many patches a day).
> 
> Blame an unhealthy appreciation for being able to write emails in Vim.
> 
> I generate patches with 'git format-patch' - what's the unusable part of
> "almost" usable here? Typically I invoke it like so:
> 
>   git format-patch -o ~/mailed-patches/blah -vN master..branchname
>   git send-email --to=git@vger.kernel.org ~/mailed-patches/blah/vN*
> 
> If there's more tweaking I should do in the workflow I'd like to know.

Ah, I think that 'git send-email' is injecting this because I added a
redundant "sendemail.from" line to my ~/.gitconfig while I was testing
out 'git bugreport' for my other patchset. I'll remove that config from
here on.

 - Emily
Junio C Hamano Jan. 24, 2020, 9:11 p.m. UTC | #4
Emily Shaffer <emilyshaffer@google.com> writes:

> On Fri, Jan 24, 2020 at 12:35:28PM -0800, Junio C Hamano wrote:
>> emilyshaffer@google.com writes:
>> 
>> > From: Emily Shaffer <emilyshaffer@google.com>
>> 
>> Hmm, unlike folks who use GGG, your From: address seem almost usable
>> without having to waste two extra lines (which matters when one has
>> to review many patches a day).
>
> Blame an unhealthy appreciation for being able to write emails in Vim.
>
> I generate patches with 'git format-patch' - what's the unusable part of
> "almost" usable here?

Compare your message I am responding here, with your message with
the patch in it.

This one has a perfectly usable "From:" address,

    From:   Emily Shaffer <emilyshaffer@google.com>

while the patch e-mail has

    From:   emilyshaffer@google.com

which cannot be quite usable as the author identity.

Patch
diff mbox series

diff --git a/Documentation/MyFirstContribution.txt b/Documentation/MyFirstContribution.txt
index 35b9130aa3..e7489d156a 100644
--- a/Documentation/MyFirstContribution.txt
+++ b/Documentation/MyFirstContribution.txt
@@ -23,6 +23,38 @@  useful additional context:
 - `Documentation/SubmittingPatches`
 - `Documentation/howto/new-command.txt`
 
+[[getting-help]]
+=== Getting Help
+
+If you get stuck, you can seek help in the following places.
+
+==== https://groups.google.com/forum/#!forum/git-mentoring[git-mentoring@googlegroups.com]
+
+This mailing list is targeted to new contributors and is a great place to post
+questions and receive kind, detailed answers from volunteers on the Git
+project. You must join the group to view messages or post.
+
+==== https://webchat.freenode.net/#git-devel[#git-devel] on Freenode
+
+This IRC channel is for conversations between Git contributors. If someone is
+currently online and knows the answer to your question, you can receive help
+in real time. Otherwise, you can read the
+https://colabti.org/irclogger/irclogger_logs/git-devel[scrollback] to see
+whether someone answered you. IRC does not allow offline private messaging, so
+if you try to private message someone and then log out of IRC, they cannot
+respond to you. It's better to ask your questions in the channel so that you
+can be answered if you disconnect and so that others can learn from the
+conversation.
+
+==== https://lore.kernel.org/git[git@vger.kernel.org]
+
+This is the main Git project mailing list where code reviews, version
+announcements, design discussions, and more take place. 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 majordomo@vger.kernel.org with
+"subscribe git" in the body.
+
 [[getting-started]]
 == Getting Started