datalad
datalad copied to clipboard
Generic issue -> Report a Bug template, Add a "Report a Generic Issue", disable "Open a blank"
- as reported by @jwodder (Closes #7528) the form is really about reporting a bug, not just opening some generic issue
- we also have "Report a Security Vulnerability" internal github issue reporting we enabled in response to #7369; Taken together with default "Open a blank issue", we would make it consistent in being imperative
edit: I also renamed "Gooey Issue" to be imperative
This just changes the name of one of the options the user is shown when creating an issue. I think you still need to add a dedicated template for generic issues.
EDIT: I think another alternative would be to set blank_issues_enabled
to true
in a .github/ISSUE_TEMPLATE/config.yml
file (docs).
This just changes the name of one of the options the user is shown when creating an issue. I think you still need to add a dedicated template for generic issues.
What would you like to see there in comparison to the default one you get with Open a blank issue.?
@yarikoptic
What would you like to see there in comparison to the default one you get with Open a blank issue.?
I mainly want the "generic/blank issue" option to be given the same prominence as the other options, not for it to be just an easy-to-miss link at the bottom of the page.
Codecov Report
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 90.70%. Comparing base (
11501cf
) to head (37e20ab
). Report is 81 commits behind head on maint.
Additional details and impacted files
@@ Coverage Diff @@
## maint #7529 +/- ##
==========================================
- Coverage 91.57% 90.70% -0.88%
==========================================
Files 325 325
Lines 43445 43459 +14
Branches 5827 0 -5827
==========================================
- Hits 39786 39418 -368
- Misses 3644 4041 +397
+ Partials 15 0 -15
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
Something like
? implemented here now
@yarikoptic Tacking on "which is not necessarily a bug" seems a little excessive, but good enough.
@yarikoptic Tacking on "which is not necessarily a bug" seems a little excessive, but good enough.
I am open to an alternative wording if someone has a better one in mind, I just wanted to make sure that it makes it clear for submitter which ones to use among available. May be other @datalad/developers have an idea for better wording - ideally suggest in suggestion mode.
a side-effect from above is that the "Generic" issue would gain that mandatory Description section in it, so it would not be totally a reproduction of a blank issue , see e.g. https://github.com/yarikoptic/datalad/issues/15 . I didn't spot ability to just make it without any section. IMHO it is ok, but wanted to make sure that we have no surprises. I will ping other @datalad/developers on matrix now.
I accepted recommendation. Would merge in a week unless there is further feedback/changes desired