Skip to content

[Documentation] Update repository clone method. Fixes issue 18050 #18051

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

[Documentation] Update repository clone method. Fixes issue 18050 #18051

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,16 @@ Within Github, navigate to <https://github.com/python/mypy> and fork the reposit
#### (2) Clone the mypy repository and enter into it

```bash
git clone git@github.com:<your_username>/mypy.git
git clone https://github.com/<your_username>/mypy.git
Copy link
Collaborator

@hamdanal hamdanal Oct 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Contributor Author

@ag-tafe ag-tafe Oct 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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?

Copy link
Member

@brianschubert brianschubert Oct 27, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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)

cd mypy
```

If you use the following command to clone instead:
```bash
git clone [email protected]:<your_username>/mypy.git
```
then make sure to connect to GitHub first: [Connecting to github with ssh](https://docs.github.com/en/authentication/connecting-to-github-with-ssh)

#### (3) Create then activate a virtual environment

```bash
Expand Down