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

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

From
Philippe Blain <levraiphilippeblain@gmail.com>
Date
May 29, 2020, 01:36 UTC
Message-ID
<7746C7A0-F328-482C-9B19-51BA5CB17C0A@gmail.com>
In-Reply-To
<20200529010608.GF114915@google.com>
Hi Emily, 
Show 48 quoted lines
> 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.
Previous: Jonathan NiederNext: Emily Shaffer
Message 3 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.