Skip to content

Commit 2823924

Browse files
ahmadawaisahmadawais
committed
📦 NEW: Issue Templates
1 parent 53811aa commit 2823924

3 files changed

Lines changed: 68 additions & 39 deletions

File tree

.github/ISSUE_TEMPLATE.md renamed to .github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 30 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
<!--
2-
PLEASE READ THE FIRST SECTION :-)
3-
-->
1+
---
2+
name: 🐛 BUG Report
3+
about: If something isn't working as expected 🤔.
44

5-
### Is this a bug report?
5+
---
66

77
<!--
88
If you answered "Yes":
@@ -14,39 +14,36 @@
1414
less details, but this makes it less likely they'll get fixed soon.
1515
1616
In either case, please fill as many fields below as you can.
17+
-->
1718

18-
If you answered "No":
19+
## Bug Report
1920

20-
If this is a question or a discussion, you may delete this template and write in a free form.
21-
Note that we don't provide help for webpack questions after ejecting.
22-
You can find webpack docs at https://webpack.js.org/.
23-
-->
21+
### Expected Behavior
2422

23+
<!--
24+
How did you expect the tool to behave?
25+
It’s fine if you’re not sure your understanding is correct.
26+
Just write down what you thought would happen.
27+
-->
2528

26-
(Write your answer here.)
29+
(Write what you thought would happen.)
2730

2831

29-
### Environment
32+
### Actual Behavior
3033

3134
<!--
32-
Please fill in all the relevant fields by running these commands in terminal.
35+
Did something go wrong?
36+
Is something broken, or not behaving as you expected?
37+
Please attach screenshots if possible! They are extremely helpful for diagnosing issues.
3338
-->
3439

35-
1. `node -v`:
36-
2. `npm -v`:
37-
3. `yarn --version` (if you use Yarn):
38-
4. `npm ls cgb-scripts` (if you haven’t ejected):
39-
40-
Then, specify:
41-
42-
1. Operating system:
43-
2. Browser and version (if relevant):
40+
(Write what happened. Please add screenshots!)
4441

4542

4643
### Steps to Reproduce
4744

4845
<!--
49-
How would you describe your issue to someone who doesn’t know you or your project?
46+
How would you describe your issue to someone who does not know you or your project?
5047
Try to write a sequence of steps that anybody can repeat to see the issue.
5148
-->
5249

@@ -56,28 +53,22 @@ Then, specify:
5653
2.
5754
3.
5855

59-
60-
### Expected Behavior
61-
6256
<!--
63-
How did you expect the tool to behave?
64-
It’s fine if you’re not sure your understanding is correct.
65-
Just write down what you thought would happen.
57+
Please fill in all the relevant fields by running these commands in terminal.
6658
-->
6759

68-
(Write what you thought would happen.)
69-
70-
71-
### Actual Behavior
60+
1. `node -v`:
61+
2. `npm -v`:
62+
3. `yarn --version` (if you use Yarn):
63+
4. `npm ls cgb-scripts` (if you haven’t ejected):
7264

73-
<!--
74-
Did something go wrong?
75-
Is something broken, or not behaving as you expected?
76-
Please attach screenshots if possible! They are extremely helpful for diagnosing issues.
77-
-->
65+
Then, specify:
7866

79-
(Write what happened. Please add screenshots!)
67+
1. Operating system:
68+
2. Browser and version (if relevant):
8069

70+
**Possible Solution**
71+
<!--- Only if you have suggestions on a fix for the bug -->
8172

8273
### Reproducible Demo
8374

@@ -110,4 +101,4 @@ Then, specify:
110101
create a reproducible example for it.
111102
112103
Thanks for helping us help you!
113-
-->
104+
-->

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: 🚀 Feature Request
3+
about: I have a suggestion (and may want to implement it 🙂)!
4+
5+
---
6+
7+
## Feature Request
8+
9+
**Is your feature request related to a problem? Please describe.**
10+
A clear and concise description of what the problem is. Ex. I have an issue when [...]
11+
12+
**Describe the solution you'd like**
13+
A clear and concise description of what you want to happen. Add any considered drawbacks.
14+
15+
**Describe alternatives you've considered**
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
18+
**Teachability, Documentation, Adoption, Migration Strategy**
19+
If you can, explain how users will be able to use this and possibly write out a version the docs.
20+
Maybe a screenshot or design?

‎.github/ISSUE_TEMPLATE/support_request.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: 🤝 Support Question
3+
about: If you have a support question 💬!
4+
5+
---
6+
7+
This is a FOSS (Free & Open Source Software) project. Providing support is a full-time job and so it's not provided for free. No promises there. 😇
8+
9+
If you'd like to support this project or hire [Ahmad Awais](https://twitter.com/mrahmadawais/) (maker of `create-guten-block`) then feel free to contact here → https://AhmadAwais.com/contact/.
10+
11+
12+
---
13+
14+
If you'd like us to keep producing professional free and open source software (FOSS). Consider paying for an hour of our dev-time. We'll spend two hours on open source for each contribution. Yeah, that's right, you pay for one hour and get both of us (Awais & Maedah) to spend an hour as a thank you.
15+
16+
🚀 $99.99 — [Support for one hour or more →](https://pay.paddle.com/checkout/515568)
17+
🔰 $49.99 — [Support half an hour maintenance →](https://pay.paddle.com/checkout/527253)
18+
☕️ $9.99 — [Buy us lunch or coffee to keep us trucking #OpenSource →](https://pay.paddle.com/checkout/527254)

0 commit comments

Comments
 (0)