k-wave-python icon indicating copy to clipboard operation
k-wave-python copied to clipboard

PR for Issue #417

Open KR616 opened this issue 1 year ago • 4 comments

[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

KR616 avatar Jun 20 '24 07:06 KR616

Codecov Report

:white_check_mark: All modified and coverable lines are covered by tests. :white_check_mark: Project coverage is 71.84%. Comparing base (63055b4) to head (016411b). :warning: Report is 107 commits behind head on master.

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.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

codecov[bot] avatar Jun 20 '24 07:06 codecov[bot]

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.

waltsims avatar Jun 21 '24 14:06 waltsims

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

KR616 avatar Jun 21 '24 14:06 KR616

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.

waltsims avatar Jun 21 '24 15:06 waltsims