-
-
Notifications
You must be signed in to change notification settings - Fork 500
docs: git:// protocol in developer workflow causes connection timeout use https:// instead #3504
Description
Describe the bug
The developer workflow documentation instructs contributors to add the upstream remote using the git:// protocol:
git remote add upstream git://github.com/tardis-sn/tardis.git
This results in a connection timeout error in many environments because the git:// protocol (port 9418) is deprecated on GitHub and is commonly blocked by firewalls and corporate/institutional networks.
Additionally, other sections of the TARDIS documentation already use https:// for remote URLs, creating an inconsistency.
To Reproduce
Follow the developer workflow documentation
Run:
git remote add upstream git://github.com/tardis-sn/tardis.git
git fetch upstream
Observe connection timeout error
Expected behavior
The command should succeed. Replacing git:// with https:// works correctly and maintains the same read-only upstream behavior:
git remote add upstream https://github.com/tardis-sn/tardis.git
Screenshots
N/A
System
OS: [e.g. Ubuntu 22.04 / macOS 14 / Windows 11]
Git version: [e.g. 2.43.0]
Network: [e.g. institutional/corporate network, home network]
Additional context
This issue was raised in the TARDIS Gitter community and affects contributors setting up their development environment for the first time.
The fix is a one-line documentation change replacing git:// with https:// in the developer workflow guide. Since GitHub officially deprecated the git:// protocol and other parts of the TARDIS docs already use https://, this change would also improve consistency across the documentation.
Suggested fix:
Before
git remote add upstream git://github.com/tardis-sn/tardis.git
After
git remote add upstream https://github.com/tardis-sn/tardis.git