Re: [PATCH] docs: mention MyFirstContribution in more places

From: Emily Shaffer <emilyshaffer@google.com>
To: Philippe Blain <levraiphilippeblain@gmail.com>
Cc: Jonathan Nieder <jrnieder@gmail.com>,
	Git List <git@vger.kernel.org>, Jeff King <peff@peff.net>
Subject: Re: [PATCH] docs: mention MyFirstContribution in more places
Date: Mon, 8 Jun 2020 13:47:00 -0700	[thread overview]
Message-ID: <20200608204700.GB148632@google.com> (raw)
In-Reply-To: <7746C7A0-F328-482C-9B19-51BA5CB17C0A@gmail.com>

On Thu, May 28, 2020 at 09:36:58PM -0400, Philippe Blain wrote:
> 
> 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 the suggestion - I like that. I'll send an update shortly.

 - Emily