Change issue template to use brackets instead of italics for readability #8012
Conversation
…ckets to denote text that the user should replace
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: If they are not already assigned, you can assign the PR to them by writing The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
@ZackButcher: The following test failed, say
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here. |
|
This probably boils down to personal prefs 😄. If we get rid of italics, I would vote for just plain text (no brackets) or just removing that text altogether. About the only value that text provides is a reminder to be "clear and concise" (which we repeat three times 😛). We could just add a intro warning that says something like "Please be clear and concise in all descriptions so that others can more quickly identify the crux of your issue." Or just update the headers to be something like (and remove the text):
|
Thanks for getting rid of the
<sup>, that was very hard to read, but I still have a hard time reading the italics. This just updates the template to surround the info text with brackets {{ like this }} to denote that the user should fill them in, rather than like this. I think it still gets the point across but makes issues more readable by using a normal font. Brackets are arbitrary, but harken to the golang template syntax.Compare the rendered markdown :
Is your feature request related to a problem? Please describe.
{{ A clear and concise description of what the problem is. }}
Describe the solution you'd like
{{ A clear and concise description of what you want to happen. }}
Describe alternatives you've considered
{{ A clear and concise description of any alternative solutions or features you've considered. }}
Additional context
{{ Add any other context about the feature request here. }}
Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is.
Describe the solution you'd like
A clear and concise description of what you want to happen.
Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.
Additional context
Add any other context about the feature request here.