syntax error in git instructions?

• Apr 2, 2014 - 01:25
  • I think there is a syntax error on the workflow page. The command given to initially clone the forked repo is git clone git@github.com:you/MuseScore.git but this did not work for me. I will state up front that I am new to git.

    I finally figured out the correct command by reading a bit further down, where I noticed the syntax of cloning the musescore repo itself (not my fork), and from that, determined that this is what would clone my fork: git clone git://github.com/you/MuseScore.git

    If both are correct, then I'm not sure why the first way did not work for me.

  • Also, I think it would be very helpful if the summary steps were themselves links to the
    longer description for each step.

Comments

• Apr 2, 2014 - 06:17

The first method requires ssh to be setup, like mentioned in the description.
The second method works too, unless you are behind a firewall, but doesn't allow upload, just download, as it doesn't do any authorization. There is a third method, via https.

Reply

• Apr 2, 2014 - 16:39

I updated the instructions to explain a bit more why you should need the git@github.com URL and why it should work (Hint: you need to setup your github account with an SSH key) If you use the git:// URL you will not be able to push on your fork. You can also use a https URL if you want.

For MuseScore repo itself, you can use git:// URL since you will not push on it.

Reply

• Apr 2, 2014 - 18:43

Quite right, I did misunderstand -- both the instructions in the workflow and the comment from lasconic above.

So, now that I understand the difference between the two types of URL, I went back and read the instructions on the workflow page again. I can see that this is what they mean.

However, I personally think that they are still confusing to someone who doesn't know this ahead of time. This is true, in part, because the instructions are like a cookbook. I was stepping through the recipe, performing each command in order. I did not read ahead before performing the clone step. And even when I did read ahead, after hitting the error, I didn't see the connection between the ssh comment and my error.

I would suggest that you add a section specifically explaining the two URL types, and make sure this section is before the instructions for using either of the URL types. That, I think, will make things much clearer.

Reply

Do you still have an unanswered question? Please log in first to post your question.