From: Daniele Sassoli <danielesassoli@xxxxxxxxx>
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@xxxxxxxxx>
---
doc:clarify which remotes can be used when contributing
cc: Elijah Newren newren@xxxxxxxxx
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-2034%2FDanieleSassoli%2Fclarify-remote-to-use-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-2034/DanieleSassoli/clarify-remote-to-use-v2
Pull-Request: https://github.com/git/git/pull/2034
Range-diff vs v1:
1: 850097696a4 ! 1: b34070c03e3 doc:clarify which remotes can be used when contributing
@@ Documentation/MyFirstContribution.adoc: Now you should be able to go and check o
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
- 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.
+-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.
++opening a Pull Request against either `gitgitgadget/git` or `git/git`. Head to
++https://github.com/gitgitgadget/git or https://github.com/git/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.
+
+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)
Documentation/MyFirstContribution.adoc | 11 +++++++----
1 file changed, 7 insertions(+), 4 deletions(-)
diff --git a/Documentation/MyFirstContribution.adoc b/Documentation/MyFirstContribution.adoc
index aca7212cfe2..bbb7b45bd4a 100644
--- a/Documentation/MyFirstContribution.adoc
+++ b/Documentation/MyFirstContribution.adoc
@@ -908,10 +908,13 @@ 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
-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.
+opening a Pull Request against either `gitgitgadget/git` or `git/git`. Head to
+https://github.com/gitgitgadget/git or https://github.com/git/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.
+
+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)
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: 1fa68948c3d76328236cac73d2adf33c905bd8e3
--
gitgitgadget
