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

Bug in the developer installation instructions #457

Open
melissacline opened this issue Oct 31, 2024 · 2 comments · May be fixed by #458
Open

Bug in the developer installation instructions #457

melissacline opened this issue Oct 31, 2024 · 2 comments · May be fixed by #458
Labels
documentation Changes to documentation only Product Review requests from VRS product review

Comments

@melissacline
Copy link

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

git clone --recurse-submodules [email protected]: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.

@melissacline melissacline added documentation Changes to documentation only Product Review requests from VRS product review labels Oct 31, 2024
@jsstevenson
Copy link
Contributor

jsstevenson commented Nov 1, 2024

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
Copy link
Contributor

jsstevenson commented Nov 1, 2024

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

edit: made a PR -- #458 (review). Happy to modify language further for accuracy/clarity

@jsstevenson jsstevenson linked a pull request Nov 1, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Changes to documentation only Product Review requests from VRS product review
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants