git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Philippe Blain <levraiphilippeblain@gmail.com>
To: Jonathan Nieder <jrnieder@gmail.com>
Cc: Emily Shaffer <emilyshaffer@google.com>,
	Git List <git@vger.kernel.org>, Jeff King <peff@peff.net>
Subject: Re: [PATCH] docs: mention MyFirstContribution in more places
Date: Thu, 28 May 2020 21:36:58 -0400	[thread overview]
Message-ID: <7746C7A0-F328-482C-9B19-51BA5CB17C0A@gmail.com> (raw)
In-Reply-To: <20200529010608.GF114915@google.com>

Hi Emily, 

> Le 28 mai 2020 à 21:06, Jonathan Nieder <jrnieder@gmail.com> a écrit :
> 
> Emily Shaffer wrote:
> 
>> While the MyFirstContribution guide exists and has received some use and
>> positive reviews, it is still not as discoverable as it could be. Add a
>> reference to it from the GitHub pull request template, where many
>> brand-new contributors may look. Also add a reference to it in
>> SubmittingPatches, which is the central source of guidance for patch
>> contribution.
>> 
>> Signed-off-by: Emily Shaffer <emilyshaffer@google.com>
>> ---
>> .github/CONTRIBUTING.md         | 3 +++
>> Documentation/SubmittingPatches | 5 +++--
>> 2 files changed, 6 insertions(+), 2 deletions(-)
> 
> Yay!
> 
>> --- a/.github/CONTRIBUTING.md
>> +++ b/.github/CONTRIBUTING.md
>> @@ -16,4 +16,7 @@ If you prefer video, then [this talk](https://www.youtube.com/watch?v=Q7i_qQW__q
>> might be useful to you as the presenter walks you through the contribution
>> process by example.
>> 
>> +Or, you can follow the ["My First Contribution"](https://git-scm.com/docs/MyFirstContribution)
>> +tutorial for another example of the contribution process.
>> +
>> Your friendly Git community!
> 
> Looks good.
> 
>> --- a/Documentation/SubmittingPatches
>> +++ b/Documentation/SubmittingPatches
>> @@ -3,8 +3,9 @@ Submitting Patches
>> 
>> == Guidelines
>> 
>> -Here are some guidelines for people who want to contribute their code
>> -to this software.
>> +Here are some guidelines for people who want to contribute their code to this
>> +software. There is also an link:MyFirstContribution.html[interactive tutorial]
>> +available which covers many of these same guidelines.
> 
> nit: when I see "an interactive tutorial" I imagine a "git tutor"
> command that interacts with me to guide me through my first
> contribution (like "vimtutor").  I think this means to just say
> "a tutorial".

I agree. Maybe "a step-by-step tutorial" ?

Thanks for taking the time to do this. That's exactly what I had in mind.

Philippe.

  reply	other threads:[~2020-05-29  1:37 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-05-28 23:49 [PATCH] docs: mention MyFirstContribution in more places Emily Shaffer
2020-05-29  1:06 ` Jonathan Nieder
2020-05-29  1:36   ` Philippe Blain [this message]
2020-06-08 20:47     ` Emily Shaffer
2020-06-08 21:11 ` [PATCH v2] " Emily Shaffer
2020-06-08 21:25   ` Philippe Blain
2020-06-08 22:12     ` Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=7746C7A0-F328-482C-9B19-51BA5CB17C0A@gmail.com \
    --to=levraiphilippeblain@gmail.com \
    --cc=emilyshaffer@google.com \
    --cc=git@vger.kernel.org \
    --cc=jrnieder@gmail.com \
    --cc=peff@peff.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).