-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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
GitHub Issue Forms: Transform Feature Request issue template to form #34068
Conversation
As forms are limited to the fields specified, I'm wondering whether this form should include an "Other" text area at the end, or just let use the "Proposed solution" field instead. 🤔 |
@@ -0,0 +1,5 @@ | |||
--- | |||
name: Other advanced issue |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just noticed GitHub uses the filename to order the options when opening an issue, not this display name. So, we can put any display text and still avoid it being on top of the list as long as the filename starts with a low-order letter.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for working on this @priethor ! I put my two cents in 😄
label: What problem does this address? | ||
description: Please describe if this feature or enhancement is related to a current problem or pain point. | ||
placeholder: | | ||
I'm always frustrated when '...'. It is currently difficult to '...'. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I noticed that this was from before, but IMO it needs to change to something way more positive 😄 . Maybe something like It would be great to have a way to...
?
label: What is your proposed solution? | ||
description: Please outline the feature or enhancement that you want and how it addresses any problem identified above. | ||
placeholder: | | ||
It would be great if '...' was posible. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess in my mind a proposed solution shouldn't be required, as someone could want an enhancement but not sure how this would be implemented.. This is related to my above comment and possibly changing this placeholder.
For example I a user wants to report for adding a new control in a block
, they might not have a proposed solution or they might have to add this control in toolbar
for some reasons etc.. Makes sense?
-ps I wrote the above comment first and then saw your almost identical placeholder 😄
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In that example, I'm picturing add a new control in a block
as the proposed solution rather than the problem at hand. The problem would be they want to do something but they don't have the right tools, hence asking for the new control (without knowing the technical implications of that proposal). Another example:
- Problem: I can't add styles to my post title.
- Proposed solution: Allow bold, underline in the post title. (Some would even propose "Enable rich text in post title").
In this scenario, the implementation of that solution to their problem would mean changing the way the post title is stored to allow rich text, but I wouldn't expect most feature requests to go that deep into the "solution".
I would love to hear more opinions, as I am sure this has already been debated when the original template this form replicates was created. In any case, the fact that we are discussing this is a hint that it may not be a clear enough format for folks opening issues 😅
Can we leave one of the templates as a freeform textarea? That's the one I use most of the time. |
There's also the blank issue at the bottom |
True, that was even less obvious 🙈 . Updated the PR and description to simply rely on the blank issue link at the bottom. 👍 |
Description
Part of #33394 and continuation to #34007. This PR tries to convert the "Feature request" issue template to a form by doing the following:
- Adding a new "Other advanced issue" (blank template).Because forms are constrained to the fields they provide, simply converting all templates to forms would make it impossible to create freeform issues for things like overview issues, tracking issues, special discussions, etc. Therefore, an "advanced" template has been added as well, which contains a blank template.While necessary, this blank template should not be promoted, and the standard forms should be favored instead for reporting bugs and new features in a homogeneous way. Therefore, I'm proposing to name it "Other advanced issue" (suggestions are welcome!) because template/forms are ordered alphabetically, and we should avoid displaying the "Blank template" on top of the list and using it by default.How has this been tested?
This can be tested in the following fork: https://github.com/priethor/gutenberg/issues/new/choose
Screenshots