public inbox for git@vger.kernel.org
 help / color / mirror / Atom feed
From: Todd Zullinger <tmz@pobox.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: Abdalrhman Mohamed <eng.abdalrhman.abdalmonem@gmail.com>,
	Emily Shaffer <nasamuffin@google.com>,
	git@vger.kernel.org
Subject: Re: [PATCH] .github/CONTRIBUTING.md: fix broken link to SubmittingPatches
Date: Sat, 31 Jan 2026 15:55:16 -0500	[thread overview]
Message-ID: <aX5sNO4aMVE-qcrz@teonanacatl.net> (raw)
In-Reply-To: <xmqqms1t4l4z.fsf@gitster.g>

Junio C Hamano wrote:
> 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

  reply	other threads:[~2026-01-31 20:55 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-01-31 16:14 [PATCH] .github/CONTRIBUTING.md: fix broken link to SubmittingPatches Abdalrhman Mohamed
2026-01-31 19:50 ` Junio C Hamano
2026-01-31 20:55   ` Todd Zullinger [this message]
2026-02-01  0:26     ` [PATCH v2] .github/CONTRIBUTING.md: link to SubmittingPatches on git-scm.com Abdalrhman Mohamed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=aX5sNO4aMVE-qcrz@teonanacatl.net \
    --to=tmz@pobox.com \
    --cc=eng.abdalrhman.abdalmonem@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=nasamuffin@google.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox