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

Guidelines for bug submission #33

Open
lrberge opened this issue Jul 20, 2020 · 0 comments
Open

Guidelines for bug submission #33

lrberge opened this issue Jul 20, 2020 · 0 comments

Comments

@lrberge
Copy link
Owner

lrberge commented Jul 20, 2020

First thanks for the interest in the package and for wanting to submit a bug report. This feedback is invaluable since it significantly improves software quality, benefiting to all users.

Here's a few guidelines before submitting a bug:

  1. Bugs are corrected at almost every release. So ensure you have the latest version of the software running. Currently it's Version .

  2. Every time a bug is corrected, it's reported in the NEWS file. Please have a look at it to see whether it isn't already fixed in the development version.

  3. I know it's some work, but please provide a minimal working example in your report with reproducible code and data. If your bug only happens for some large data set and you're not able to make it appear for data of smaller size, you can DM me the data. A minimal working example ensures that:

    1. you really have encountered a bug and it's not a user-side mistake.
    2. it can be quickly solved.

There are many very good examples of bug reports in past issues (see #4, #10, or #17 to name a few).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant