[Documentation] Update repository clone method. Fixes issue 18050 #18051
Conversation
ag-tafe
changed the title
| git clone git@github.com:<your_username>/mypy.git | ||
| git clone https://github.com/<your_username>/mypy.git |
There was a problem hiding this comment.
I don't think this is a good idea given that this is the contributing guide where people would want to push to the repository but cannot with a https clone. Maybe add the link to GitHub shh docs but keep this command unchanged?
There was a problem hiding this comment.
@hamdanal No problem at all. I'm just still a newbie about github. If I'm to amend this pull request should I do it locally and then push onto my fork of mypy for the pull request to automatically amend or just cancel this pull request and create a new one?
There was a problem hiding this comment.
@ag-tafe The former. You can update this PR by making changes locally and pushing to the branch in your fork. Any new commits will appear in the PR history.
In case helpful as a reference, this is what the cloning instructions look like in CPython's contribution guide: https://devguide.python.org/getting-started/setup-building/
(btw: it looks like your commit email is associated with a different github account than the one you opened this PR with)
Fixes #18050
Makes cloning of the repository easier for new starters. It allows to skip a complicated step of generating ssh keys, but provides a link to detailed instructions on how to do so.