threads / patch / 64889

patch.github/CONTRIBUTING.md: fix broken link to SubmittingPatches

Subject: [PATCH] .github/CONTRIBUTING.md: fix broken link to SubmittingPatches

## tl;dr

4 messages between Jan 31, 2026 and Feb 1, 2026. Diffs are folded; open one to read it.

replies: 3people: 3as markdown or json

Abdalrhman Mohamed· Jan 31, 2026, 16:14 UTC · lore

The link to SubmittingPatches documentation was pointing to a non-existent 'Documentation' branch. Correct it to point to the 'master' branch so that new contributors on GitHub can find the submission guidelines.

Signed-off-by: Abdalrhman Mohamed <Eng.Abdalrhman.Abdalmonem@gmail.com>
---
 .github/CONTRIBUTING.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Show changes to .github/CONTRIBUTING.md +1 −1
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index c8755e38de..e5d696fd42 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -10,7 +10,7 @@ conveniently send your Pull Requests commits to our mailing list.
 
 Please read ["A note from the maintainer"](https://git.kernel.org/pub/scm/git/git.git/plain/MaintNotes?h=todo)
 to learn how the Git project is managed, and how you can work with it.
-In addition, we highly recommend you to read [our submission guidelines](../Documentation/SubmittingPatches).
+In addition, we highly recommend you to read [our submission guidelines](https://github.com/git/git/blob/master/Documentation/SubmittingPatches).
 
 If you prefer video, then [this talk](https://www.youtube.com/watch?v=Q7i_qQW__q4&feature=youtu.be&t=6m4s)
 might be useful to you as the presenter walks you through the contribution

-- 
2.25.1
Junio C Hamano· Jan 31, 2026, 19:50 UTC · re: Abdalrhman Mohamed · lore

Re: [PATCH] .github/CONTRIBUTING.md: fix broken link to SubmittingPatches

Abdalrhman Mohamed <eng.abdalrhman.abdalmonem@gmail.com> writes:
> -In addition, we highly recommend you to read [our submission guidelines](../Documentation/SubmittingPatches).
> +In addition, we highly recommend you to read [our submission guidelines](https://github.com/git/git/blob/master/Documentation/SubmittingPatches).

The line is overly long already in the original; can we make it a bit more readable?

As to the contents, referring to our preformatted docs, like
    https://git.github.io/htmldocs/SubmittingPatches
would probably be more appropriate, no?
Todd Zullinger· Jan 31, 2026, 20:55 UTC · re: Junio C Hamano · lore

Re: [PATCH] .github/CONTRIBUTING.md: fix broken link to SubmittingPatches

Junio C Hamano wrote:
Show 13 quoted lines
> Abdalrhman Mohamed <eng.abdalrhman.abdalmonem@gmail.com> writes:
> 
>> -In addition, we highly recommend you to read [our submission guidelines](../Documentation/SubmittingPatches).
>> +In addition, we highly recommend you to read [our submission guidelines](https://github.com/git/git/blob/master/Documentation/SubmittingPatches).
> 
> The line is overly long already in the original; can we make it a
> bit more readable?
> 
> As to the contents, referring to our preformatted docs, like
> 
>     https://git.github.io/htmldocs/SubmittingPatches
> 
> would probably be more appropriate, no?
A few lines below, the document links to git-scm.com/docs:
    Or, you can follow the ["My First Contribution"](https://git-scm.com/docs/MyFirstContribution)
    tutorial for another example of the contribution process.

I didn't look at any discussion around b75a219904 (docs: mention MyFirstContribution in more places, 2020-06-08) where that was added. It would make sense to be consistent about where the links point, e.g.:

    https://git-scm.com/docs/SubmittingPatches

As CONTRIBUTING.md is in the .github directory, it's probably fine to link there for both. On the other hand, having more references to the upstream site might be good for consistency across the various places the Git code is hosted. Maybe that increases the standing of git-scm.com in search rankings too, I don't know.

Whatever the reasoning, it should probably apply to both links.

-- 
Todd
Abdalrhman Mohamed· Feb 1, 2026, 00:26 UTC · re: Todd Zullinger · lore

[PATCH v2] .github/CONTRIBUTING.md: link to SubmittingPatches on git-scm.com

The relative link to SubmittingPatches is broken when viewed through GitHub's specialized "Contributing" tab. Update the link to point to the documentation on git-scm.com to be consistent with other links in the same file. Also, wrap the line to improve readability.

Signed-off-by: Abdalrhman Mohamed <Eng.Abdalrhman.Abdalmonem@gmail.com>
---
 .github/CONTRIBUTING.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
Show changes to .github/CONTRIBUTING.md +2 −1
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index c8755e38de..93042128d6 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -10,7 +10,8 @@ conveniently send your Pull Requests commits to our mailing list.
 
 Please read ["A note from the maintainer"](https://git.kernel.org/pub/scm/git/git.git/plain/MaintNotes?h=todo)
 to learn how the Git project is managed, and how you can work with it.
-In addition, we highly recommend you to read [our submission guidelines](../Documentation/SubmittingPatches).
+In addition, we highly recommend you to read
+[our submission guidelines](https://git-scm.com/docs/SubmittingPatches).
 
 If you prefer video, then [this talk](https://www.youtube.com/watch?v=Q7i_qQW__q4&feature=youtu.be&t=6m4s)
 might be useful to you as the presenter walks you through the contribution

-- 
2.50.1

← back to recent threads