Re: [PATCH] docs: mention MyFirstContribution in more places
- From
Jonathan Nieder <jrnieder@gmail.com>
- Date
- May 29, 2020, 01:06 UTC
- Message-ID
- <20200529010608.GF114915@google.com>
- In-Reply-To
- <20200528234939.145396-1-emilyshaffer@google.com>
Emily Shaffer wrote:
Show 12 quoted lines
> 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!
Show 10 quoted lines
> --- 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.
Show 11 quoted lines
> --- 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".
With that tweak, Reviewed-by: Jonathan Nieder <jrnieder@gmail.com>
Thanks.