Skip to content

Commit 0434b07

Browse files
committed
Create initial github issue templates
1 parent 8f2a195 commit 0434b07

File tree

4 files changed

+99
-0
lines changed

4 files changed

+99
-0
lines changed

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: 🐞 Bug Report
2+
description: Report a reproducible bug.
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Need help or support? Please don't open an issue!
9+
Head to [Stack Overflow](https://stackoverflow.com/questions/tagged/howler.js) or [Discussions](https://github.com/goldfire/howler.js/discussions).
10+
11+
- type: textarea
12+
attributes:
13+
label: The Problem
14+
description: Describe the issue you are experiencing here, to communicate to the maintainers. Tell us what you were trying to do and what happened. Provide a clear and concise description of what the problem is.
15+
validations:
16+
required: true
17+
18+
- type: input
19+
attributes:
20+
label: Reproducible Example
21+
description: If possible, please provide the URL to a reproducible example of the issue (using something like CodePen, JSFiddle, etc).
22+
23+
- type: textarea
24+
attributes:
25+
label: Reproduction Steps
26+
description: What steps are required to reproduce the issue you are reporting?
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
attributes:
32+
label: Possible Solution
33+
description: If you have suggestions on a fix for the bug.
34+
35+
- type: textarea
36+
attributes:
37+
label: Context
38+
description: How has this issue affected you? What are you trying to accomplish? Providing context helps to determine the best real-world solution.
39+
40+
- type: input
41+
attributes:
42+
label: Howler.js Version
43+
description: Which version of `howler.js` are you using?
44+
placeholder: "v0.0.0"
45+
validations:
46+
required: true
47+
48+
- type: input
49+
attributes:
50+
label: Affected Browser(s)/Versiuon(s)

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Technical Help
4+
url: https://stackoverflow.com/questions/tagged/howler.js
5+
about: Need help or support? Head to https://stackoverflow.com/questions/tagged/howler.js.
6+
- name: Support and Discussion
7+
url: https://github.com/goldfire/howler.js/discussions
8+
about: Please use the forum if you have questions or need help.

.github/ISSUE_TEMPLATE/docs.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: 📚 Documentation
2+
description: Report an error or area that needs clarification.
3+
labels: ["docs"]
4+
body:
5+
- type: checkboxes
6+
attributes:
7+
label: "Documentation Is:"
8+
options:
9+
- label: Missing
10+
- label: Confusing
11+
- label: Incorrect
12+
- label: Other
13+
14+
- type: textarea
15+
attributes:
16+
label: Describe Issue
17+
description: Describe what the issue is in detail, and link to the current section if applicable.
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
attributes:
23+
label: Suggested Improvement
24+
description: How do you think it could be improved?
25+
validations:
26+
required: true

.github/ISSUE_TEMPLATE/feature.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: ✨ Feature Request
2+
description: Suggest a new idea or feature.
3+
labels: ["feature"]
4+
body:
5+
- type: textarea
6+
attributes:
7+
label: Feature Proposal
8+
description: What are you trying to accomplish? Please provide context about why this is needed for the core library and useful for broad use-cases.
9+
validations:
10+
required: true
11+
12+
- type: textarea
13+
attributes:
14+
label: Possible Implementation
15+
description: If you have ideas for how this could be implemented (whether code-wise or, API, etc), provide those details here.

0 commit comments

Comments
 (0)