Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
woocommerce/plugins/woocommerce-admin/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

21 lines
640 B
Markdown
Raw Normal View History

Adds GitHub templates to ensure good issue and PR descriptions
2018-10-10 14:33:38 +00:00
---
name: Feature request
about: Suggest an idea for this project
---
Update issue templates (https://github.com/woocommerce/woocommerce-admin/pull/7088) - 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"
2021-07-06 09:46:33 +00:00
### 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 […] -->
Adds GitHub templates to ensure good issue and PR descriptions
2018-10-10 14:33:38 +00:00
Update issue templates (https://github.com/woocommerce/woocommerce-admin/pull/7088) - 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"
2021-07-06 09:46:33 +00:00
### Describe the solution you'd like
<!-- A clear and concise description of what you want to happen. -->
Adds GitHub templates to ensure good issue and PR descriptions
2018-10-10 14:33:38 +00:00
Update issue templates (https://github.com/woocommerce/woocommerce-admin/pull/7088) - 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"
2021-07-06 09:46:33 +00:00
### Describe alternatives you've considered
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
Adds GitHub templates to ensure good issue and PR descriptions
2018-10-10 14:33:38 +00:00
Update issue templates (https://github.com/woocommerce/woocommerce-admin/pull/7088) - 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"
2021-07-06 09:46:33 +00:00
### Should this be prioritized? Why?
Adds GitHub templates to ensure good issue and PR descriptions
2018-10-10 14:33:38 +00:00
Update issue templates (https://github.com/woocommerce/woocommerce-admin/pull/7088) - 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"
2021-07-06 09:46:33 +00:00
### Additional context
<!--Any additional context, screenshots, or details you think might be helpful.-->