Skip to content

Conversation

KR616
Copy link
Contributor

@KR616 KR616 commented Jun 20, 2024

[Feature] New issue template for compilation/ executing error

This pull request addresses issue #417

Changes made:

  • Added a new issue template "error_report" to reduce repetition and improve quality of questions/ help.

Testing Steps:

  • create a new issue and select template

Copy link

codecov bot commented Jun 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.84%. Comparing base (63055b4) to head (016411b).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #418   +/-   ##
=======================================
  Coverage   71.84%   71.84%           
=======================================
  Files          46       46           
  Lines        6744     6744           
  Branches     1496     1496           
=======================================
  Hits         4845     4845           
  Misses       1333     1333           
  Partials      566      566           
Flag Coverage Δ
3.10 72.04% <ø> (ø)
3.11 72.04% <ø> (ø)
3.12 72.04% <ø> (ø)
3.9 71.81% <ø> (ø)
macos-latest 71.78% <ø> (ø)
ubuntu-latest 71.81% <ø> (ø)
windows-latest 71.82% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@waltsims
Copy link
Owner

Thanks for this @KR616. Is the implied difference between a bug and an error that a bug is a developer error while an error is a user error? I find the distinction unclear from the naming. Let's clarify the added value of the distinction before merging this in.

Copy link
Owner

@waltsims waltsims left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please see my comment

@KR616
Copy link
Contributor Author

KR616 commented Jun 21, 2024

I agree. I was unsure how to call this category. How about somethign along the lines of "Help Desk"?

@waltsims
Copy link
Owner

I like help desk. I think we should also make clear the questions should be pointed and specific. We should warn that code dumps of "can you help me here is my code" will be closed without comment. Lastly, we should ask what steps the user has taken thus far to find the answer (e.g. read the documentation, or look at specific examples), and have the user share links to understand their understanding of the problem and encourage them to look for solutions before opening an issue.

@KR616 KR616 requested a review from waltsims July 17, 2024 09:02

## Please note
<!-- A brief description of what you expected to happen. -->
- We may ignore any issues due to a lack of time and apologize.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove this line. We could rephrase it but removal might be best for now.

- We may ignore any issues due to a lack of time and apologize.
- Please first always refer to the [documentation](https://k-wave-python.readthedocs.io/en/latest/index.html), or specific [examples](https://github.com/waltsims/k-wave-python/tree/master/examples) before raising an issue
- Code dumps "can you help, here is my code" will be closed without comment
- Be as specific as possible and write in detail what you have already tried, add links and any reference that may help us understand
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Add any links and references to resources you have referenced in your problem solving.

execution_options = SimulationExecutionOptions(is_gpu_simulation=True, verbose_level=2)
```

## Environment information
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps you can add the commands they can run to get this information? They do this on scipy for example.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We might be able to query many global variables in kwave.init


## Steps to reproduce
<!-- Step-by-step process to reproduce the behavior -->
- What script/example did you run? Please provide necessary information.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minimal example to reproduce your issue

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

Successfully merging this pull request may close these issues.

2 participants