| Message ID | 20200608211132.194267-1-emilyshaffer@google.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [v2] docs: mention MyFirstContribution in more places | expand |
Hi Emily, > Le 8 juin 2020 à 17:11, Emily Shaffer <emilyshaffer@google.com> a écrit : > > 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 Thanks. Looks good. Reviewed-by: Philippe Blain <levraiphilippeblain@gmail.com>
Philippe Blain <levraiphilippeblain@gmail.com> writes: > Hi Emily, > >> Le 8 juin 2020 à 17:11, Emily Shaffer <emilyshaffer@google.com> a écrit : >> >> 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 > > Thanks. Looks good. > > Reviewed-by: Philippe Blain <levraiphilippeblain@gmail.com> Thanks, both.
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.
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(-)