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.

Sign up for GitHub

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

Jump to bottom

GitHub Issue Forms: Transform Feature Request issue template to form #34068

Closed
wants to merge 10 commits into from
Closed

GitHub Issue Forms: Transform Feature Request issue template to form #34068

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
eeb8efa
Create advanced (blank) tempalte
priethor Aug 13, 2021
dbc59cd
Create advanced (blank) issue template
priethor Aug 13, 2021
62800f1
Create feature request form
priethor Aug 13, 2021
6be7e8c
Delete Feature_request.md
priethor Aug 13, 2021
6672ed5
Fix yaml structure
priethor Aug 13, 2021
e011097
Fix yaml structure
priethor Aug 13, 2021
dd9a65e
Rename blank template
priethor Aug 13, 2021
e2570fc
Rename Advanced_template.md to Blank_issue_template.md
priethor Aug 13, 2021
fd2c102
Rename Blank_issue_template.md to Other_issue_template.md
priethor Aug 13, 2021
85f7fe0
Delete Other_issue_template.md
priethor Aug 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 0 additions & 18 deletions .github/ISSUE_TEMPLATE/Feature_request.md
View file
Open in desktop

This file was deleted.

20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/Feature_request.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Feature request
description: Report a bug with the WordPress block editor or Gutenberg plugin
title: 'Feature request: '
body:
- type: textarea
attributes:
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 '...'.
Copy link
Contributor

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

validations:
required: true
- type: textarea
attributes:
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.
Copy link
Contributor

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 😄

Copy link
Contributor Author

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 😅

validations:
required: true