git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v2] docs: mention MyFirstContribution in more places

From
Emily Shaffer <emilyshaffer@google.com>
Date
Jun 8, 2020, 21:11 UTC
Message-ID
<20200608211132.194267-1-emilyshaffer@google.com>
In-Reply-To
<20200528234939.145396-1-emilyshaffer@google.com>

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>
---

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(-)
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..ecf9438cf0 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 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.
-- 
2.27.0.278.ge193c7cf3a9-goog
Previous: Emily ShafferNext: Philippe Blain
Message 5 of 7 in “docs: mention MyFirstContribution in more places”
  1. docs: mention MyFirstContribution in more placesEmily Shaffer, May 28, 2020
  2. Jonathan NiederMay 29, 2020
  3. Philippe BlainMay 29, 2020
  4. Emily ShafferJun 8, 2020
  5. docs: mention MyFirstContribution in more placesEmily Shaffer, Jun 8, 2020
  6. Philippe BlainJun 8, 2020
  7. Junio C HamanoJun 8, 2020

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.