Skip to content

Commit 3c8910f

Browse files
author
DJ Katalina
authored
Improve issue templates (darkreader#6310)
1 parent 380f1d7 commit 3c8910f

5 files changed

Lines changed: 124 additions & 120 deletions

File tree

‎.github/ISSUE_TEMPLATE/broken-website.md‎

Lines changed: 30 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,56 @@
11
---
2-
name: Broken website
3-
about: Creates a broken website report about Dark Reader
2+
name: Broken Website Report
3+
about: Create a report about a website issue you experienced while using Dark Reader.
44
title: "[Broken Website] Replace with title"
55
labels: Broken Website
66
assignees: ''
77
---
88

9-
<!--
10-
⚠⚠ Do not delete this issue template! ⚠⚠
11-
Issues that do not use the issue template/don't fill out the essential information are likely to be ignored and closed.
9+
<!--
10+
⚠⚠ Do not delete this issue template! ⚠⚠
11+
Reported issues must use this template and have all the necessary information provided.
12+
Incomplete reports are likely to be ignored and closed.
1213
-->
1314

1415
<!--
15-
Thank you for taking the time to report a broken website.
16-
Please make sure there is no existing issue with this broken website.
17-
Make sure to fill out every section when needed else remove the section.
18-
Don't forget to add the website in the issue title.
16+
Thank you for taking the time to create a report about a website issue.
17+
Ensure that there are no other existing reports for this website issue.
18+
Also, remember to fill out every section on this report and remove any that are not needed.
19+
Finally, place the website address in the title of this report.
1920
-->
2021

21-
# Broken Website
22-
## Website
23-
<!-- The link to the website where you can observe the issue. -->
22+
# Broken Website Report
2423

24+
## Website Address
25+
<!-- Provide the website address to allow us to troubleshoot this website issue. -->
2526

26-
## How to Reproduce
27-
<!-- We need to know how you encountered the bug to properly troubleshoot the issue. -->
27+
## Steps To Reproduce
28+
<!-- Provide steps to reproduce the problem, and allowing us to troubleshoot this website issue. -->
2829
<!--
29-
An example of this is:
30-
- Go to x site
31-
- Hover over x button
32-
- See that when hovering it isn't changing colors
30+
Here is an example:
31+
- Go to example.com.
32+
- Hover over the example button.
33+
- Notice that when hovering over the example button, it does not change color.
3334
-->
3435

36+
## Expected Behavior
37+
<!-- Provide a clear and concise description of what you expected to happen. -->
3538

36-
## Expected behavior
37-
<!-- A clear and concise description of what you expected to happen. -->
38-
39-
40-
## Actual behavior
41-
<!-- A clear and concise description of what actually happened. -->
42-
39+
## Actual Behavior
40+
<!-- Provide a clear and concise description of what happened. -->
4341

4442
## Screenshots
45-
<!-- If applicable, add screenshots to help explain your problem. -->
46-
43+
<!-- If applicable, add screenshots to help explain this website issue. -->
4744

4845
## System Information
4946
<!--
50-
Please add a version of the browser you are using.
51-
If you don't know how to get your browser/Dark Reader version please search it up online.
47+
Specify the browser name and version as well as the Dark Reader version you are using.
48+
Please do an online search for help if you are not familiar with how to get this information.
5249
-->
5350

5451
- OS: <!-- e.g. Windows, macOS, Linux -->
55-
- Browser: <!-- e.g. Chrome 91, Firefox 88, Safari 14 -->
56-
- Dark Reader Version: <!-- e.g. 4.9.33 -->
57-
58-
## Additional context
59-
<!-- Add any other context about the problem here. -->
52+
- Browser: <!-- e.g. Chrome 91, Firefox 90, Edge 91, Safari 14 -->
53+
- Dark Reader Version: <!-- e.g. 4.9.34 -->
6054

55+
## Additional Context
56+
<!-- Provide any additional information about this website issue. -->

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 31 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,56 @@
11
---
2-
name: Bug report
3-
about: Create a bug report to help us improve
4-
title: "[BUG] Replace with title"
2+
name: Bug Report
3+
about: Create a report about a bug you experienced while using Dark Reader.
4+
title: "[Bug] Replace with title"
55
labels: bug
66
assignees: ''
7-
87
---
98

10-
<!--
11-
⚠⚠ Do not delete this issue template! ⚠⚠
12-
Issues that do not use the issue template/don't fill out the essential information are likely to be ignored and closed.
9+
<!--
10+
⚠⚠ Do not delete this issue template! ⚠⚠
11+
Reported issues must use this template and have all the necessary information provided.
12+
Incomplete reports are likely to be ignored and closed.
1313
-->
1414

1515
<!--
16-
Thank you for taking the time to report a bug.
17-
Please make sure there is no existing issue with this kind of bug.
18-
Make sure to fill out every section when needed else remove the section.
16+
Thank you for taking the time to create a report about a bug.
17+
Ensure that there are no other existing reports for this bug.
18+
Also, remember to fill out every section on this report and remove any that are not needed.
19+
Finally, place a brief description in the title of this report.
1920
-->
2021

2122
# Bug Report
2223

23-
## Describe the bug
24-
<!-- A clear and concise description of what the bug is. -->
24+
## Bug Description
25+
<!-- Provide a clear and concise description to allow us to troubleshoot this bug. -->
2526

26-
## Steps to reproduce
27-
<!-- We need to know how you encountered the bug to properly troubleshoot the issue. -->
27+
## Steps To Reproduce
28+
<!-- Provide steps to reproduce the problem, and allowing us to troubleshoot this bug. -->
2829
<!--
29-
An example of this is:
30-
- Go to x site
31-
- Hover over x button
32-
- See that when hovering it isn't changing colors
30+
Here is an example:
31+
- Go to example.com.
32+
- Hover over the example button.
33+
- Notice that when hovering over the example button, it does not change color.
3334
-->
3435

35-
## Expected behavior
36-
<!-- A clear and concise description of what you expected to happen. -->
36+
## Expected Behavior
37+
<!-- Provide a clear and concise description of what you expected to happen. -->
3738

38-
## Actual behavior
39-
<!-- A clear and concise description of what actually happened. -->
39+
## Actual Behavior
40+
<!-- Provide a clear and concise description of what happened. -->
4041

4142
## Screenshots
42-
<!-- If applicable, add screenshots to help explain your problem. -->
43+
<!-- If applicable, add screenshots to help explain this bug. -->
4344

4445
## System Information
4546
<!--
46-
Please add a version of the browser you are using.
47-
If you don't know how to get your browser/Dark Reader version please search it up online.
47+
Specify the browser name and version as well as the Dark Reader version you are using.
48+
Please do an online search for help if you are not familiar with how to get this information.
4849
-->
4950

50-
- OS: <!-- [e.g. Windows, macOS, Linux] -->
51-
- Browser: <!-- [e.g. Chrome 89, Firefox 87, Safari 14] -->
52-
- Dark Reader Version: <!-- [e.g. 4.9.30] -->
51+
- OS: <!-- e.g. Windows, macOS, Linux -->
52+
- Browser: <!-- e.g. Chrome 91, Firefox 90, Edge 91, Safari 14 -->
53+
- Dark Reader Version: <!-- e.g. 4.9.34 -->
5354

54-
## Additional context
55-
<!--Add any other context about the problem here. -->
55+
## Additional Context
56+
<!-- Provide any additional information about this bug. -->

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,31 @@
11
---
2-
name: Feature request
3-
about: Suggest a new Feature for Dark Reader
2+
name: Feature Request
3+
about: Create a request for a feature to enhance the experience while using Dark Reader.
44
title: "[Feature Request] Replace with title"
55
labels: enhancement
66
assignees: ''
7-
87
---
98

10-
<!--
11-
⚠⚠ Do not delete this issue template! ⚠⚠
12-
Issues that do not use the issue template/don't fill out the essential information are likely to be ignored and closed.
9+
<!--
10+
⚠⚠ Do not delete this issue template! ⚠⚠
11+
Reported issues must use this template and have all the necessary information provided.
12+
Incomplete reports are likely to be ignored and closed.
1313
-->
1414

1515
<!--
16-
Thank you for taking the time to suggest a feature request.
17-
Please make sure there is no existing issue about this kind of feature.
18-
Make sure to fill out every section when needed else remove the section.
16+
Thank you for taking the time to create a feature request.
17+
Ensure that there are no other existing requests for this feature.
18+
Also, remember to fill out every section on this request and remove any that are not needed.
19+
Finally, place a brief description in the title of this request.
1920
-->
2021

2122
# Feature Request
2223

23-
## Is your feature request related to a problem? Please describe
24-
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
24+
## Is this feature request related to a problem?
25+
<!-- Provide a clear and concise description of the problem and the solution. -->
2526

26-
## Describe the solution you'd like
27-
<!-- A clear and concise description of what you want to happen. -->
27+
## Screenshots
28+
<!-- If applicable, add screenshots to help explain this feature request. -->
2829

29-
## Additional context
30-
<!-- Add any other context or screenshots about the feature request here. -->
30+
## Additional Context
31+
<!-- Provide any additional information about this feature request. -->

‎.github/ISSUE_TEMPLATE/performance_issue.md‎

Lines changed: 38 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,59 @@
11
---
2-
name: Performance issues
3-
about: Adress a performance issue of Dark Reader
4-
title: "[Performance] Replace with title"
5-
labels:
2+
name: Performance Issue Report
3+
about: Create a report about a performance issue you experienced while using Dark Reader.
4+
title: "[Performance Issue] Replace with title"
5+
labels: Performance Issue
66
assignees: ''
7-
87
---
98

10-
<!--
11-
⚠⚠ Do not delete this issue template! ⚠⚠
12-
Issues that do not use the issue template/don't fill out the essential information are likely to be ignored and closed.
9+
<!--
10+
⚠⚠ Do not delete this issue template! ⚠⚠
11+
Reported issues must use this template and have all the necessary information provided.
12+
Incomplete reports are likely to be ignored and closed.
1313
-->
1414

1515
<!--
16-
Thank you for taking the time to a performance issue.
17-
Please make sure there is no existing issue about this issue.
18-
And make sure it's a actually performance issue, e.g. a extra 1 second to loading the website isn't a performance issue.
16+
Thank you for taking the time to create a report about a performance issue.
17+
Ensure that there are no other existing reports for this performance issue.
18+
Also, remember to fill out every section on this report and remove any that are not needed.
19+
Finally, place a brief description in the title of this report.
20+
NOTE: Ensure that this is an actual performance issue.
21+
One extra second to load the website is not a performance issue.
1922
-->
2023

21-
# Performance Issue
24+
# Performance Issue Report
2225

23-
## Website
24-
<!-- If applicable, the link of the website where the performance issue is noticed. -->
26+
## Website Address
27+
<!-- Provide the website address to allow us to troubleshoot this performance issue. -->
2528

26-
## How to Reproduce
27-
<!-- We need to know how you encountered the bug to properly troubleshoot the issue. -->
29+
## Steps To Reproduce
30+
<!-- Provide steps to reproduce the problem, and allowing us to troubleshoot this performance issue. -->
2831
<!--
29-
An example of this is:
30-
- Go to '...'
31-
- Click on '...'
32-
- Notice spikes in CPU Usage
32+
Here is an example:
33+
- Go to example.com.
34+
- Hover over the example button.
35+
- Notice spikes in CPU usage.
3336
-->
3437

35-
## Performance Profiler
36-
<!-- A link to either profile.zip *Chromium only* or a firefox profiler *Firefox only*. -->
38+
## Performance Profile
39+
<!-- Provide a link to a Chromium or a Firefox profile. -->
40+
41+
## Screenshots
42+
<!-- If applicable, add screenshots to help explain this performance issue. -->
3743

3844
## System Information
3945
<!--
40-
Please add a version of the browser you are using.
41-
If you don't know how to get your browser/Dark Reader version please search it up online.
46+
Specify the browser name and version as well as the Dark Reader version you are using.
47+
Please do an online search for help if you are not familiar with how to get this information.
4248
-->
4349

44-
- OS: <!-- [e.g. Windows, macOS, Linux] -->
45-
- Browser: <!-- [e.g. Chrome 89, Firefox 87, Safari 14] -->
46-
- Dark Reader Version: <!-- [e.g. 4.9.30] -->
50+
- OS: <!-- e.g. Windows, macOS, Linux -->
51+
- Browser: <!-- e.g. Chrome 91, Firefox 90, Edge 91, Safari 14 -->
52+
- Dark Reader Version: <!-- e.g. 4.9.34 -->
4753

48-
<!--
49-
Do you have this performance issue with Dark Reader disabled?
50-
Does it happen in other browsers?
51-
Do you have hardware acceleration enabled?
52-
-->
54+
## Additional Context
55+
- Does this happen when Dark Reader is disabled?
56+
- Does this happen in other browsers?
57+
- Do you have hardware acceleration enabled?
5358

54-
## Additional context
55-
<!-- Add any other context or screenshots about the feature request here. -->
59+
<!-- Provide any additional information about this performance issue. -->

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
---
22
name: Question
3-
about: Ask a question
4-
title: "[Question]"
3+
about: Ask a question about Dark Reader.
4+
title: "[Question] Replace with title"
55
labels: question
66
assignees: ''
7-
87
---
8+
99
<!--
10-
Before asking a question make sure that you have read:
11-
http://darkreader.org/help/
10+
Before asking a question, ensure that you have read:
11+
https://darkreader.org/help/
12+
13+
Place a brief description in the title of this question.
1214
-->
1315

14-
**Question**
15-
A clear and concise description of what your question is.
16+
# Question
17+
<!-- Provide a clear and concise description of what the question is. -->

0 commit comments

Comments
 (0)