threads / discuss / 55258

Found error in documentation, looking for advice on how to start contributing

Subject: Found error in documentation, looking for advice on how to start contributing

## tl;dr

4 messages between Mar 5, 2021 and Mar 5, 2021.

replies: 3people: 3as markdown or json

Dominik Lameter· Mar 5, 2021, 00:04 UTC · lore

Hi all,

I don't know if this is the place for this question, let me know if I should send it elsewhere.

I was reading a portion of the documentation today and found a paragraph out of place in my local documentation, as well as on https://git-scm.com/docs/git-log and in the git/git GitHub repository. I have never contributed to an open source project before and I think this would be a simple place to start. I've read through the readme and Documentation/SubmittingPatches document, however with the https://github.com/git/git repository being publish only, what git repository do I base my changes on for documentation patches?

Thanks in advance, Dominik

p.s. sorry if this email is a duplicate, this one should be plain text

Emily Shaffer· Mar 5, 2021, 00:31 UTC · re: Dominik Lameter · lore

Re: Found error in documentation, looking for advice on how to start contributing

On Thu, Mar 04, 2021 at 06:04:01PM -0600, Dominik Lameter wrote:

> 
> Hi all,

Hi and welcome!

Show 12 quoted lines

> 
> I don't know if this is the place for this question, let me know if I
> should send it elsewhere.
> 
> I was reading a portion of the documentation today and found a
> paragraph out of place in my local documentation, as well as on
> https://git-scm.com/docs/git-log and in the git/git GitHub repository.
> I have never contributed to an open source project before and I think
> this would be a simple place to start. I've read through the readme
> and Documentation/SubmittingPatches document, however with the
> https://github.com/git/git repository being publish only, what git
> repository do I base my changes on for documentation patches?

I think the My First Contribution guide can help you, especially if you start from here: https://git-scm.com/docs/MyFirstContribution#add-documentation

(The rest of the guide before that anchor may also be useful to you, but not specifically for a documentation change.)

This is definitely the right list, so do write back if you have questions that aren't answered by that guide.

 - Emily

Dominik Lameter· Mar 5, 2021, 01:38 UTC · re: Emily Shaffer · lore

Re: Found error in documentation, looking for advice on how to start contributing

Awesome, thanks! I'll go through that link.

On Thu, Mar 4, 2021, 6:31 PM Emily Shaffer <emilyshaffer@google.com> wrote:

Show 31 quoted lines

>
> On Thu, Mar 04, 2021 at 06:04:01PM -0600, Dominik Lameter wrote:
> >
> > Hi all,
>
> Hi and welcome!
>
> >
> > I don't know if this is the place for this question, let me know if I
> > should send it elsewhere.
> >
> > I was reading a portion of the documentation today and found a
> > paragraph out of place in my local documentation, as well as on
> > https://git-scm.com/docs/git-log and in the git/git GitHub repository.
> > I have never contributed to an open source project before and I think
> > this would be a simple place to start. I've read through the readme
> > and Documentation/SubmittingPatches document, however with the
> > https://github.com/git/git repository being publish only, what git
> > repository do I base my changes on for documentation patches?
>
> I think the My First Contribution guide can help you, especially if you
> start from here:
> https://git-scm.com/docs/MyFirstContribution#add-documentation
>
> (The rest of the guide before that anchor may also be useful to you, but
> not specifically for a documentation change.)
>
> This is definitely the right list, so do write back if you have
> questions that aren't answered by that guide.
>
>  - Emily

Martin Ågren· Mar 5, 2021, 17:08 UTC · re: Dominik Lameter · lore

Re: Found error in documentation, looking for advice on how to start contributing

Hi Dominik,

Welcome to the list.

On Fri, 5 Mar 2021 at 02:04, Dominik Lameter <dominik@graphe.net> wrote:

Show 7 quoted lines

> I don't know if this is the place for this question, let me know if I
> should send it elsewhere.
>
> this would be a simple place to start. I've read through the readme
> and Documentation/SubmittingPatches document, however with the
> https://github.com/git/git repository being publish only, what git
> repository do I base my changes on for documentation patches?

You can certainly clone from github.com/git/git, no problem, or make a fork. The "publish only" remark means that commits/patches don't reach that repo through pull requests, i.e., they don't really enter "through" GitHub. Rather, they reach Junio (the maintainer) through this mailing list. He'll carefully collect the various topics flying around here and turn them into branches, and publish those at various places, one of which is github.com. Thus "publish only". Anyway, long story short, you've found the right place. :-)

And all that said, there is a way of making a GitHub pull request in a way that it reaches this mailing list: GitGitGadget. I saw that Emily referred you to MyFirstContribution.txt -- you'll find more there.

By the time you feel ready to submit a patch, feel free to cc me and I'd be happy to try to review it. And even before then, if you have any questions, just ask. :-)

Martin