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

ENH: Add link and short description of how to report issues and bugs #85

Open
bsipocz opened this issue Aug 24, 2022 · 0 comments
Open
Labels
content Issues regarding the content of the notebooks enhancement New feature or request

Comments

@bsipocz
Copy link
Contributor

bsipocz commented Aug 24, 2022

If we add a link for how to report issues and bugs to the notebooks or pyvo or astroquery etc, it's more likely that people will actually report those.

Therefore I suggest to add a cell with a sentence of two and a link at the bottom/or top of each and every of our notebooks. Mention that the report is the most useful if a copy pasteable code to reproduce the issue is included (the concept of minimal reproducible example, can link this very nice scikit-learn doc [0] about it, but we can distill our own version of it, too, and link to that one instead)

[0] - https://scikit-learn.org/dev/developers/minimal_reproducer.html

@bsipocz bsipocz added enhancement New feature or request content Issues regarding the content of the notebooks labels Aug 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Issues regarding the content of the notebooks enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant