search

ga4gh / vrs-python

GA4GH Variation Representation Python Implementation
https://github.com/ga4gh/vrs
Apache License 2.0
51 stars 27 forks source link

Bug in the developer installation instructions #457

Open melissacline opened 2 weeks ago

melissacline commented 2 weeks ago

In the Readme, under the installation instructions for developers there is this line:

git clone --recurse-submodules git@github.com:YOUR_GITHUB_ID/vrs-python.git

When I test that with my github ID (melissacline), it doesn't work. When I replace my github ID with "ga4gh", then it works.

jsstevenson commented 2 weeks ago

Hi @melissacline -- did you fork the repo (line above this one)? I think that ga4gh/vrs-python works for you because you're part of the ga4gh GitHub org and have maintainer access to the repo, but I think this line is targeting members of the public who don't have commit permissions to the repo. In that case, they have to fork (on GitHub) and clone their fork to make commits.

jsstevenson commented 2 weeks ago

Either way, we could make this easier and clearer by adding a hyperlink to fork onto that text.

edit: made a PR -- https://github.com/ga4gh/vrs-python/pull/458#pullrequestreview-2410737354. Happy to modify language further for accuracy/clarity