docs: mention MyFirstContribution in more places
diff mbox series

Message ID 20200528234939.145396-1-emilyshaffer@google.com
State New
Headers show
Series
  • docs: mention MyFirstContribution in more places
Related show

Commit Message

Emily Shaffer May 28, 2020, 11:49 p.m. UTC
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>
---
Philippe mentioned out-of-band that they wished for some more pointers
to MyFirstContribution in the Git documentation
(https://github.com/git/git-scm.com/issues/1464#issuecomment-631757274).

Here's a first pass. The change for the GH PR template was easy, since
there are a couple other "here's how" resources listed the same way. But
the change for SubmittingPatches I wasn't so sure about. Since that
document dives right into technical details and doesn't feature some
"other resources" section (at least not that I found), I made a quick
reference at the top, which I was hoping would be unintrusive but also
easy to find for newbies overwhelmed by the large list of rules. It's
not very scalable if we want to add more info, though, so I'm open to
other suggestions.

 - Emily

 .github/CONTRIBUTING.md         | 3 +++
 Documentation/SubmittingPatches | 5 +++--
 2 files changed, 6 insertions(+), 2 deletions(-)

Comments

Jonathan Nieder May 29, 2020, 1:06 a.m. UTC | #1
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".

With that tweak,
Reviewed-by: Jonathan Nieder <jrnieder@gmail.com>

Thanks.
Philippe Blain May 29, 2020, 1:36 a.m. UTC | #2
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.
Emily Shaffer June 8, 2020, 8:47 p.m. UTC | #3
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

Patch
diff mbox series

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index e7b4e2f3c2..c8755e38de 100644
--- 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!
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 4515cab519..d8c6b4d71b 100644
--- 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.
 
 [[base-branch]]
 === Decide what to base your work on.