diff mbox series

[v3] MyFirstContribution: add avenues for getting help

Message ID 20191213013128.6268-1-emilyshaffer@google.com (mailing list archive)
State New, archived
Headers show
Series [v3] MyFirstContribution: add avenues for getting help | expand

Commit Message

Emily Shaffer Dec. 13, 2019, 1:31 a.m. UTC
With https://public-inbox.org/git/20191114194708.GD60198@google.com/ we
now have a mentoring mailing list, to which we should direct new
contributors who have questions.

Since #git-devel's traffic is fairly low, it should be OK to direct some
questions there too. 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>
---
Since v2:

- Removed a double slash in a URL
- public-inbox -> lore.kernel.org
- Removed indication that Git list should be a fallback; instead, treat
  it as equally useful for first attempt at Q&A.

As for the conversation which spun off regarding the access controls on
git-mentoring list, since the list still hasn't seen traffic, I'm going
to keep them as they are for a little longer.

 - Emily

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

Comments

Derrick Stolee Dec. 13, 2019, 3 a.m. UTC | #1
On 12/12/2019 8:31 PM, Emily Shaffer wrote:
> With https://public-inbox.org/git/20191114194708.GD60198@google.com/ we

We are trying to move to lore.kernel.org, I think.

> now have a mentoring mailing list, to which we should direct new
> contributors who have questions.
> 
> Since #git-devel's traffic is fairly low, it should be OK to direct some
> questions there too. 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>
> ---
> Since v2:
> 
> - Removed a double slash in a URL
> - public-inbox -> lore.kernel.org

Ah, I see you mentioned it here and in the contents. Commit messages
are harder to keep straight, in my experience.

> +==== https://lore.kernel.org/git[git@vger.kernel.org]
Emily Shaffer Dec. 13, 2019, 4:14 a.m. UTC | #2
On Thu, Dec 12, 2019 at 10:00:45PM -0500, Derrick Stolee wrote:
> On 12/12/2019 8:31 PM, Emily Shaffer wrote:
> > With https://public-inbox.org/git/20191114194708.GD60198@google.com/ we
> 
> We are trying to move to lore.kernel.org, I think.

Argh, and I even wordsmithed a few paragraphs down in this commit
message too. Sending..

> 
> > now have a mentoring mailing list, to which we should direct new
> > contributors who have questions.
> > 
> > Since #git-devel's traffic is fairly low, it should be OK to direct some
> > questions there too. 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>
> > ---
> > Since v2:
> > 
> > - Removed a double slash in a URL
> > - public-inbox -> lore.kernel.org
> 
> Ah, I see you mentioned it here and in the contents. Commit messages
> are harder to keep straight, in my experience.
> 
> > +==== https://lore.kernel.org/git[git@vger.kernel.org]
Junio C Hamano Dec. 13, 2019, 5:20 p.m. UTC | #3
Emily Shaffer <emilyshaffer@google.com> writes:

> Since #git-devel's traffic is fairly low, it should be OK to direct some
> questions there too.

Correct me if I recall wrong, but wasn't #git the original IRC
channel we developers hang out on, and then somebody thought "the
traffic is fairly low, so it should be OK" and directed non
developer trafic there, which caused the developers to migrate out
to #git-devel, a new channel?
Emily Shaffer Dec. 13, 2019, 5:49 p.m. UTC | #4
On Fri, Dec 13, 2019 at 09:20:20AM -0800, Junio C Hamano wrote:
> Emily Shaffer <emilyshaffer@google.com> writes:
> 
> > Since #git-devel's traffic is fairly low, it should be OK to direct some
> > questions there too.
> 
> Correct me if I recall wrong, but wasn't #git the original IRC
> channel we developers hang out on, and then somebody thought "the
> traffic is fairly low, so it should be OK" and directed non
> developer trafic there, which caused the developers to migrate out
> to #git-devel, a new channel?

I certainly don't have the background to correct you, as that was before
my time, but I can say that this document isn't directing non-developer
traffic. This is a tutorial for aspiring Git developers to ask questions
about Git development.

 - Emily
Junio C Hamano Dec. 13, 2019, 6:40 p.m. UTC | #5
Emily Shaffer <emilyshaffer@google.com> writes:

> On Fri, Dec 13, 2019 at 09:20:20AM -0800, Junio C Hamano wrote:
>> Emily Shaffer <emilyshaffer@google.com> writes:
>> 
>> > Since #git-devel's traffic is fairly low, it should be OK to direct some
>> > questions there too.
>> 
>> Correct me if I recall wrong, but wasn't #git the original IRC
>> channel we developers hang out on, and then somebody thought "the
>> traffic is fairly low, so it should be OK" and directed non
>> developer trafic there, which caused the developers to migrate out
>> to #git-devel, a new channel?
>
> I certainly don't have the background to correct you, as that was before
> my time, but I can say that this document isn't directing non-developer
> traffic. This is a tutorial for aspiring Git developers to ask questions
> about Git development.

I do not necessarily think it is a bad idea, but the rationale must
be "#git-devel is for those who work on git, so it is very on topic
there", not "it is low traffic so anything can be sent there".
diff mbox series

Patch

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