Skip to contentSkip to conversation

docs: mention MyFirstContribution in more places

PATCH Superseded Emily Shaffer 4 participants 7 messages May 28, 2020 – Jun 8, 2020 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs: mention MyFirstContribution in more places

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.

---
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(-)
.github/CONTRIBUTING.md +3 -0
index e7b4e2f3c2..c8755e38de 100644
@@ -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!
Documentation/SubmittingPatches +3 -2
index 4515cab519..d8c6b4d71b 100644
@@ -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.
Signature · 1 line
2.27.0.rc0.183.gde8f92d652-goog
Reviewed-by on v1 1/1
#1 lore raw
Quoted 7 lines · Emily Shaffer

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.

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

Yay!

.github/CONTRIBUTING.md If you prefer video, then [this talk](https://www.youtube.com/watch?v=Q7i_qQW__q · line 22

Quoted 10 lines
.github/CONTRIBUTING.md +3 -0
@@ -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.

Documentation/SubmittingPatches Submitting Patches · line 8

Quoted 11 lines
Documentation/SubmittingPatches +3 -2
@@ -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,

Thanks.

#2 lore raw

Hi Emily,

Quoted 38 lines · Jonathan Nieder
Quoted 7 lines · Emily Shaffer

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.

Quoted 5 lines

---
.github/CONTRIBUTING.md | 3 +++
Documentation/SubmittingPatches | 5 +++--

2 files changed, 6 insertions(+), 2 deletions(-)

Yay!

Quoted 10 lines
.github/CONTRIBUTING.md +0 -0
@@ -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.

.github/CONTRIBUTING.md +3 -0
+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.

Quoted 6 lines
Documentation/SubmittingPatches +0 -0
@@ -3,8 +3,9 @@ Submitting Patches
 

== Guidelines

Quoted 10 lines

Documentation/SubmittingPatches Submitting Patches · line 8

Quoted 5 lines
Documentation/SubmittingPatches +3 -2
-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.

#3 lore raw
Quoted 52 lines · Philippe Blain

Hi Emily,

Quoted 38 lines · Jonathan Nieder
Quoted 7 lines · Emily Shaffer

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.

Quoted 5 lines

---
.github/CONTRIBUTING.md | 3 +++
Documentation/SubmittingPatches | 5 +++--

2 files changed, 6 insertions(+), 2 deletions(-)

Yay!

Quoted 10 lines
.github/CONTRIBUTING.md +0 -0
@@ -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.

.github/CONTRIBUTING.md +3 -0
+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.

Quoted 6 lines
Documentation/SubmittingPatches +0 -0
@@ -3,8 +3,9 @@ Submitting Patches
 

== Guidelines

Quoted 10 lines

Documentation/SubmittingPatches Submitting Patches · line 8

Quoted 5 lines
Documentation/SubmittingPatches +3 -2
-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".

Quoted 1 line

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

Thanks for the suggestion - I like that. I'll send an update shortly.

- Emily

#4 lore raw

PATCH v2 1/1 docs: mention MyFirstContribution in more places

In reply to Emily Shaffer

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.

---

Since v1, only the tiny nit - took Philippe's advice to refer to a "step-by-step" tutorial, instead of an "interactive" tutorial.

Thanks.
- Emily

 .github/CONTRIBUTING.md         | 3 +++
 Documentation/SubmittingPatches | 5 +++--
 2 files changed, 6 insertions(+), 2 deletions(-)
.github/CONTRIBUTING.md +3 -0
index e7b4e2f3c2..c8755e38de 100644
@@ -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!
Documentation/SubmittingPatches +3 -2
index 4515cab519..ecf9438cf0 100644
@@ -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 a link:MyFirstContribution.html[step-by-step tutorial]
+available which covers many of these same guidelines.
 
 [[base-branch]]
 === Decide what to base your work on.
Signature · 1 line
2.27.0.278.ge193c7cf3a9-goog
Reviewed-by on v2 1/1
#5 lore raw

Hi Emily,

Quoted 9 lines · Emily Shaffer

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.

Quoted 8 lines

---

Since v1, only the tiny nit - took Philippe's advice to refer to a "step-by-step" tutorial, instead of an "interactive" tutorial.

Thanks.
- Emily

Thanks. Looks good.

#6 lore raw
Quoted 17 lines · Philippe Blain

Hi Emily,

Quoted 15 lines · Emily Shaffer

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.

---

Since v1, only the tiny nit - took Philippe's advice to refer to a "step-by-step" tutorial, instead of an "interactive" tutorial.

Quoted 6 lines
Quoted 2 lines

Thanks.
- Emily

Thanks. Looks good.

Thanks, both.