Skip to content

Commit

Permalink
Create initial github issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
goldfire committed Jan 23, 2022
1 parent 8f2a195 commit 0434b07
Show file tree
Hide file tree
Showing 4 changed files with 99 additions and 0 deletions.
50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: 🐞 Bug Report
description: Report a reproducible bug.
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Need help or support? Please don't open an issue!
Head to [Stack Overflow](https://stackoverflow.com/questions/tagged/howler.js) or [Discussions](https://github.com/goldfire/howler.js/discussions).
- type: textarea
attributes:
label: The Problem
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.
validations:
required: true

- type: input
attributes:
label: Reproducible Example
description: If possible, please provide the URL to a reproducible example of the issue (using something like CodePen, JSFiddle, etc).

- type: textarea
attributes:
label: Reproduction Steps
description: What steps are required to reproduce the issue you are reporting?
validations:
required: true

- type: textarea
attributes:
label: Possible Solution
description: If you have suggestions on a fix for the bug.

- type: textarea
attributes:
label: Context
description: How has this issue affected you? What are you trying to accomplish? Providing context helps to determine the best real-world solution.

- type: input
attributes:
label: Howler.js Version
description: Which version of `howler.js` are you using?
placeholder: "v0.0.0"
validations:
required: true

- type: input
attributes:
label: Affected Browser(s)/Versiuon(s)
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Technical Help
url: https://stackoverflow.com/questions/tagged/howler.js
about: Need help or support? Head to https://stackoverflow.com/questions/tagged/howler.js.
- name: Support and Discussion
url: https://github.com/goldfire/howler.js/discussions
about: Please use the forum if you have questions or need help.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: 📚 Documentation
description: Report an error or area that needs clarification.
labels: ["docs"]
body:
- type: checkboxes
attributes:
label: "Documentation Is:"
options:
- label: Missing
- label: Confusing
- label: Incorrect
- label: Other

- type: textarea
attributes:
label: Describe Issue
description: Describe what the issue is in detail, and link to the current section if applicable.
validations:
required: true

- type: textarea
attributes:
label: Suggested Improvement
description: How do you think it could be improved?
validations:
required: true
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: ✨ Feature Request
description: Suggest a new idea or feature.
labels: ["feature"]
body:
- type: textarea
attributes:
label: Feature Proposal
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.
validations:
required: true

- type: textarea
attributes:
label: Possible Implementation
description: If you have ideas for how this could be implemented (whether code-wise or, API, etc), provide those details here.

0 comments on commit 0434b07

Please sign in to comment.