Change git remote paths from HTTPS to SSH #502
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -71,7 +71,7 @@ This will be: | |||
|
|
|||
| * Your GitHub username, if you're working outside of an organization. | |||
|
|
|||
| This is used to construct URLs to your project, as in: ``https://github.com/{{project_organization}}/{{project_name}}``. | |||
| This is used to construct URLs to your project, as in: ``git@github.com:{{project_organization}}/{{project_name}}``. | |||
There was a problem hiding this comment.
This line in documentation is specifically about constructing web URLs, so should remain HTTP.
| @@ -45,7 +45,7 @@ questions: | |||
| * - *What github organization will your project live under?* | |||
| - This will either be a github organization, or your github username, if you're working outside | |||
| of an organization. This is used to construct URLs to your project, like | |||
| ``https://github.com/{{project_organization}}/{{project_name}}`` | |||
| ``git@github.com:{{project_organization}}/{{project_name}}`` | |||
There was a problem hiding this comment.
Same here - it's about creating web URLs (e.g. for readme badges) so should stay HTTP.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Change Description
Usually, SSH git URLs are used for remotes when working from the terminal. This PR proposes to change the suggested
git remote addcommand to use SSH paths instead of HTTPS paths.However, I'm not sure about other use cases: GUI clients, VS Code, etc.
Checklist
lincc-frameworks/python-project-templaterepo and not a downstream one instead.