Re: [PATCH] doc:clarify which remotes can be used when contributing

From: Daniele Sassoli <danielesassoli@gmail.com>
Date: Aug 20, 2025, 14:07 UTC
Message-ID: <363ac6d1-8444-4d48-a66b-51ea139f4e87@gmail.com>
In-Reply-To: <xmqqms7vc8mo.fsf@gitster.g>

On 19/08/2025 22:19, Junio C Hamano wrote:

Show 15 quoted lines

> "Daniele Sassoli via GitGitGadget" <gitgitgadget@gmail.com> writes:
>>   https://github.com/gitgitgadget/git and open a PR either with the "New pull
>>   request" button or the convenient "Compare & pull request" button that may
>>   appear with the name of your newly pushed branch.
>> +If you're using https://github.com/git/git as your remote, you will need to
>> +open the pull-request from your fork, selecting `git/git` as base.
>> +
>> +The differences between using `gitgitgadget/git` and `git/git` as your base can
>> +be found [here](https://gitgitgadget.github.io/#should-i-use-gitgitgadget-on-gitgitgadgets-git-fork-or-on-gits-github-mirror)
> Looking at the table, there is no advantage to use git/git at all.
>
> Instead of telling them that they can use either (with reduced
> capabilities if you pick one of them instead of the other), wouldn't
> it be easier for the user if this section taught them how to switch
> their fork that they originally created out of git/git to be based

Most of the document, including the "Getting Started" section, points to cloning from git/git. It's only when it comes to the gitgitgadget section that we mention gitgitgadget/git.

It's true that there are no advantages of using git/git over gitgitgadget/git, but I would argue that the disadvantages are quite minor and definitely don't impact someone at their first contribution?

As we've told the reader so far to use git/git, I don't see why we should tell him to change his remote for potentially no benefit. If we're saying that gitgitgadget should be used only on gitgitgadget/git, then we should restructure the document to point to that from the beginning, no?

PS. please note it's my first time replying on the mailing list directly, apologies if I did something wrong, like wrong posting style or wrong people in cc.

Show 15 quoted lines

> on gitgitgadget/git instead?  Something along the lines of
>
>      ... If you originally forked from https://github.com/git/git/,
>      you can easily correct it by running (you only need to do this
>      once):
>
>      $ git remote set-url origin https://github.com/gitgitgadget/git/
>      $ git fetch --prune origin
>
>      A pull request at https://github.com/gitgitgadget/git/ can be
>      opened once you do so.
>
> but you'd need to validate the procedure, as I didn't try it myself.
>
> Thanks.