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

From: Elijah Newren <newren@gmail.com>
Date: Aug 22, 2025, 18:45 UTC
Message-ID: <CABPp-BEVzNDurd1h+Jw905RO9bg16eDacqg_Ee7GD66Muj0fSg@mail.gmail.com>
In-Reply-To: <pull.2034.git.git.1755630882418.gitgitgadget@gmail.com>

On Tue, Aug 19, 2025 at 12:14 PM Daniele Sassoli via GitGitGadget <gitgitgadget@gmail.com> wrote:

Show 33 quoted lines

>
> From: Daniele Sassoli <danielesassoli@gmail.com>
>
> The docs mostly point to using git/git as one's remote, however, when it
> comes to Sending a PR to GitGitGadget section, the reader is told to use
> gitgitgadget/git, with no mention of git/git, potentially leading to
> some confusion.
>
> Clarify that both gitgitgadget/git and git/git can be used, albeit with
> some differences.
>
> Signed-off-by: Daniele Sassoli <danielesassoli@gmail.com>
> ---
>     doc:clarify which remotes can be used when contributing
>
> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-2034%2FDanieleSassoli%2Fclarify-remote-to-use-v1
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-2034/DanieleSassoli/clarify-remote-to-use-v1
> Pull-Request: https://github.com/git/git/pull/2034
>
>  Documentation/MyFirstContribution.adoc | 8 +++++++-
>  1 file changed, 7 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/MyFirstContribution.adoc b/Documentation/MyFirstContribution.adoc
> index aca7212cfe2..d014c5c36e1 100644
> --- a/Documentation/MyFirstContribution.adoc
> +++ b/Documentation/MyFirstContribution.adoc
> @@ -908,10 +908,16 @@ Now you should be able to go and check out your newly created branch on GitHub.
>  === Sending a PR to GitGitGadget
>
>  In order to have your code tested and formatted for review, you need to start by
> -opening a Pull Request against `gitgitgadget/git`. Head to
> +opening a Pull Request against either `gitgitgadget/git` or `git/git`, depending
> +on which mirror you initially cloned from. Head to

I think mentioning that opening a PR in either project is fine is helpful...especially since the UI sometimes changes the target to git/git when I wanted to open against gitgitgadget/git, and I don't notice and I open yet another PR in the wrong place. However, having it opened in the wrong place rarely makes any meaningful difference, so it would probably be helpful to let new users know that it's okay to open it in either place as you do here.

However, where you cloned from doesn't matter when you open the pull request, so I'd strike the ", depending on which mirror you initially cloned from." part of this change.

Show 5 quoted lines

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

...and I think we should strike these two sentences as well, or at least reword them; your remote URL is immaterial.

(Not only have I opened up against both gitgitgadget/git and git/git in the past, my clone URL wasn't necessarily either one of these.)

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

I like this call out.

Show 6 quoted lines

>  Review the PR's title and description, as they're used by GitGitGadget
>  respectively as the subject and body of the cover letter for your change. Refer
>
> base-commit: c44beea485f0f2feaf460e2ac87fdd5608d63cf0
> --
> gitgitgadget

Thanks for sending the patch in.