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/BUG_REPORT.md

44 lines
1.0 KiB
Markdown
Raw Normal View History

Adds GitHub templates to ensure good issue and PR descriptions
2018-10-10 14:33:38 +00:00
---
name: Bug report
about: Create a report to help us improve
---
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 bug
<!-- A clear and concise description of what the bug is. Please be as descriptive as possible. -->
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
### To Reproduce
<!-- Describe the steps to reproduce the behavior.-->
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
1. Go to '…'
2. Click on '…'
3. Scroll down to …'
Adds GitHub templates to ensure good issue and PR descriptions
2018-10-10 14:33:38 +00:00
4. See error
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
### Actual behavior:
<!-- A clear and concise description of what actually happens. -->
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
### Screenshots
<!-- If applicable, add screenshots to help explain your problem. -->
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
### Expected behavior
<!-- A clear and concise description of what you expected to happen. -->
### Desktop (please complete the following information):
Adds GitHub templates to ensure good issue and PR descriptions
2018-10-10 14:33:38 +00:00
* OS: [e.g. iOS]
* Browser [e.g. chrome, safari]
* Version [e.g. 22]
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
### Smartphone (please complete the following information):
Adds GitHub templates to ensure good issue and PR descriptions
2018-10-10 14:33:38 +00:00
* Device: [e.g. iPhone6]
* OS: [e.g. iOS8.1]
* Browser [e.g. stock browser, safari]
* Version [e.g. 22]
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 or details you think might be helpful.-->
<!--Ticket numbers/links, plugin versions, system statuses etc.-->