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

Generic issue -> Report a Bug template, Add a "Report a Generic Issue", disable "Open a blank" #7529

Open
wants to merge 6 commits into
base: maint
Choose a base branch
from

Conversation

yarikoptic
Copy link
Member

@yarikoptic yarikoptic commented Nov 3, 2023

edit: I also renamed "Gooey Issue" to be imperative

- as reported by @jwodder in datalad#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 datalad#7369;  Taken together with
  default "Open a blank issue", we would make it consistent in being
  imperative
@jwodder
Copy link
Member

jwodder commented Nov 3, 2023

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).

@yarikoptic
Copy link
Member Author

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 yarikoptic added the semver-internal Changes only affect the internal API label Nov 3, 2023
@jwodder
Copy link
Member

jwodder commented Nov 3, 2023

@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.

Copy link

codecov bot commented Nov 3, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

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     

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

@yarikoptic yarikoptic changed the title Generic issue -> Report a Bug template Generic issue -> Report a Bug template, Add a "Report a Generic Issue", disable "Open a blank" Nov 6, 2023
@yarikoptic
Copy link
Member Author

Something like

image

? implemented here now

@jwodder
Copy link
Member

jwodder commented Nov 6, 2023

@yarikoptic Tacking on "which is not necessarily a bug" seems a little excessive, but good enough.

@yarikoptic
Copy link
Member Author

@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.

@yarikoptic
Copy link
Member Author

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. yarikoptic#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.

@@ -0,0 +1 @@
blank_issues_enabled: false
Copy link
Member

Choose a reason for hiding this comment

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

I usually open a blank issue, do we really have to remove it entirely?

Copy link
Member

Choose a reason for hiding this comment

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

Same

Copy link
Member Author

Choose a reason for hiding this comment

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

"Report a generic issue" is pretty much that, that is why I disabled to avoid possible confusion. But as I don't care enough -- I now committed suggested making it available as well.

@yarikoptic
Copy link
Member Author

I accepted recommendation. Would merge in a week unless there is further feedback/changes desired

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
semver-internal Changes only affect the internal API
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Creating a "Generic Issue" should not present the user with prompts for a bug report
4 participants