change clone instructions from git to https protocol #5526
Merged
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.
This PR resolves an issue that attempting to clone the repository may result in the error "Permission denied (publickey).".
Issue
CONTRIBUTING.md > Writing Documentation > Clone your forked repository contains the following instructions to "Clone your forked repository":
This may result in a failure to clone the forked repo. For example:
The cloning instructions use
SSH
syntax and require anSSH
certificate to work. This is not described in the instructions.Change
The instructions are changed to use the
https
protocol, which is widely available and requires no other preparation:Previously
git clone [email protected]:<your username>/cypress-documentation.git
changed to
git clone https://github.com/<your username>/cypress-documentation.git
Reference