- Use headings in issues templates,
	instead of bold paragraphs.
	To match with PR template, to improve readability and accessibility.
- Add the "Actual behavior" section.
	The reviewer, would not have to get that from the description or test locally.
- Reorder sections,
	Screenshots (and actual behavior) describes what you have immediately after you perform "steps to reproduce", so therefore could be stated there. It's hard to make a screenshot of the "expected behavior", which is not happening.
- Move section descriptions to comments.
	This way the issuer could still keep them in place while filling the sections, answering those requests.
- Use ellipsis character instead of three dots.
	To make it more readable, by fully sighted and visually impaired readers https://tosbourn.com/the-importance-of-using-the-ellipsis-character not to read it as "dot dot dot"
This commit is contained in:
Tomek Wytrębowicz 2021-07-06 11:46:33 +02:00 committed by GitHub
parent af97dd68b5
commit e48fabe964
2 changed files with 28 additions and 24 deletions

View File

@ -5,35 +5,39 @@ about: Create a report to help us improve
---
**Describe the bug**
A clear and concise description of what the bug is.
### Describe the bug
<!-- A clear and concise description of what the bug is. Please be as descriptive as possible. -->
**To Reproduce**
Steps to reproduce the behavior:
### To Reproduce
<!-- Describe the steps to reproduce the behavior.-->
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
1. Go to ''
2. Click on ''
3. Scroll down to '
4. See error
**Expected behavior**
A clear and concise description of what you expected to happen.
### Actual behavior:
<!-- A clear and concise description of what actually happens. -->
**Screenshots**
If applicable, add screenshots to help explain your problem.
### Screenshots
<!-- If applicable, add screenshots to help explain your problem. -->
**Desktop (please complete the following information):**
### Expected behavior
<!-- A clear and concise description of what you expected to happen. -->
### Desktop (please complete the following information):
* OS: [e.g. iOS]
* Browser [e.g. chrome, safari]
* Version [e.g. 22]
**Smartphone (please complete the following information):**
### Smartphone (please complete the following information):
* Device: [e.g. iPhone6]
* OS: [e.g. iOS8.1]
* Browser [e.g. stock browser, safari]
* Version [e.g. 22]
**Additional context**
Add any other context about the problem here.
### Additional context
<!--Any additional context or details you think might be helpful.-->
<!--Ticket numbers/links, plugin versions, system statuses etc.-->

View File

@ -5,16 +5,16 @@ about: Suggest an idea for this project
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
### Is your feature request related to a problem? Please describe.
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when […] -->
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
### 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.
### Describe alternatives you've considered
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
**Should this be prioritized? Why?**
### Should this be prioritized? Why?
**Additional context**
Add any other context or screenshots about the feature request here.
### Additional context
<!--Any additional context, screenshots, or details you think might be helpful.-->