-
Notifications
You must be signed in to change notification settings - Fork 91
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
More explicitly direct people to run notebooks with tox
#1239
Comments
I'm happy to add the documentation, but I'm not sure how effective it is to keep adding things like this to our READMEs. They already contain a lot of information, only some of which is relevant to each contributor, and I doubt contributors review them regularly for updates. I think ideally we'd have a unified workflow which everyone follows, then we could do things like switch to SVGs, update packages, etc. without needing contributors to set their config or remember to run another script. This is kinda what I'd hoped for with A potential solution is to incorporate something like the "auto execute" function from #601. We know for a fact all contributors go through PRs, and it makes running tox a one-step process with no local configuration necessary. I do still think it's worth documenting processes such as how to deploy tutorials; contributors will seek those out when they need them. I just think it's kinda futile adding rules and guidelines. |
tox
?
In the backlog sweep, we agreed with you, Frank. Rather than telling people how to better configure VSCode, we should be directing them to use So this issue is now revisiting the README to see if we can make this expectation more clear. |
tox
?tox
Closes #1239 --------- Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
) Closes Qiskit#1239 --------- Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
The majority of our authors use VSCode, which will by default generate PNGs rather than the superior SVGs. We should tell them how to set up VSCode to use SVGs instead.
This is probably a global config you set for Jupyter?
This change would help avoid the need for #1226.
The text was updated successfully, but these errors were encountered: