Skip to content
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.

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

Highlight clone destination of Owner's repository #573

Open
wants to merge 1 commit into
base: gh-pages
from

Conversation

@spco
Copy link

@spco spco commented Nov 5, 2018

Very often my learners cause problems by not fully reading the instructions around cloning the Owner's repo. Several times I've had learners overwrite their own local repository by cloning another's into the same location. This edit highlights to learners that they should avoid this.

Very often my learners cause problems by not fully reading the instructions around cloning the Owner's repo. Several times I've had learners overwrite their own local repository by cloning another's into the same location. This edit highlights to learners that they should avoid this.
@pagrubel
Copy link

@pagrubel pagrubel commented Dec 11, 2018

Your pull request is a good idea. However I think there may be a typo, first the file says "into a different location to her own". Do you mean "than her own"? Also, since you want to be explicit you might even want to say "different than the existing planets repo in her Desktop folder" or some other explicit wording.
I would think about adding another sentence like:
"Instead let's designate a directory with the owner's name such as vlad-planets (replace vlad with owner's name)."

@kekoziar
Copy link
Contributor

@kekoziar kekoziar commented Jan 11, 2019

@spco, I agree with @pagrubel that this clarification is a good idea. However, the sentence "The Collaborator doesn’t want to overwrite her own version of planets.git, so needs to clone the Owner’s repository to a different location to her own." is a little clunky.

Perhaps it can be revised to say
"The Collaborator doesn’t want to overwrite her own version of planets.git, so will clone the Owner’s repository to a new folder called vlad-planets which will be created with the git clone command."

What do you think?

@munkm
Copy link
Member

@munkm munkm commented Jan 21, 2019

I'd just like to add that this is a great clarification @spco. I also agree with @kekoziar and @pagrubel that making the language flow a bit more smoothly would improve this PR. If you add these changes, I think this would be ready to merge! 🎉

If you're extra motivated maybe you could also add an aside or something saying which command actually does overwrite the collaborator's local copy (this isn't necessary to include unless you want to). Your PR mentions that this could happen in words, but really emphasizing which command should be avoided would be a good way to make sure it won't be missed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants