Skip to content

Commit

Permalink
Added issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
aure committed Sep 3, 2022
1 parent 7282ac0 commit 638c2ea
Show file tree
Hide file tree
Showing 2 changed files with 107 additions and 0 deletions.
78 changes: 78 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
name: Bug report
description: Create a bug report about a reproducible problem.
labels: bug
body:
- type: markdown
attributes:
value: "# Demonstrate Your Bug in a Test"
- type: markdown
attributes:
value: |
1. Make a fork of the repo,
2. Create a test in the repo's Tests folder,
3. Make a pull request showing the test failing to meet expectations.
- type: markdown
attributes:
value: "## Source Answers from the Community"
- type: markdown
attributes:
value: Creating a test is the only sure-fire way to get our attention, but if you feel like your problem is in implementing AudioKit or one of its repos in your own code, post your problem to [StackOverflow](https://stackoverflow.com/search?q=AudioKit) with the `#AudioKit` hashtag.
- type: markdown
attributes:
value: "## Professional Assistance"
- type: markdown
attributes:
value: You may [sponsor my work on this project](https://github.com/sponsors/aure).

Certain tiers will allow you to reserve me for consulting time, and sponsors at any level get more attention than non-sponsors.
- type: markdown
attributes:
value: "# Bug Report if Not Possible to Write a Failing Test"
- type: dropdown
id: operating-system
attributes:
label: "macOS Version(s) Used to Build"
description: The operating system version being used to build (not the target runtime OS version).
multiple: true
options:
- "macOS 13 Ventura"
- "macOS 12 Monterey"
- "macOS 11 Big Sur"
- "macOS 10.15 Catalina"
- "macOS 10.14 Mojave"
- "macOS 10.13 High Sierra"
- "macOS 10.12 Sierra"
- "macOS 10.11 El Capitan"
- "macOS 10.10 Yosemite"
- "macOS 10.9 Mavericks"
validations:
required: true
- type: dropdown
id: xcode-version
attributes:
label: "Xcode Version(s)"
multiple: true
options:
- "Xcode 14"
- "Xcode 13.4.1"
- "Xcode 13.4"
- "Xcode 13.3.1"
- "Xcode 13.3"
- "Xcode 13.2.1"
- "Xcode 13.2"
- "Xcode 13.1"
- "Xcode 13.0"
validations:
required: true
- type: textarea
id: bug-description
attributes:
label: Description
description: "A clear and concise description of the bug and steps to reproduce."
validations:
required: true
- type: textarea
id: crash-logs-and-screenshots
attributes:
label: Crash Logs, Screenshots or Other Attachments (if applicable)
description: "A clear and concise description of the bug and steps to reproduce."
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Feature request
description: Suggest an idea for this project.
body:
- type: textarea
id: basic-description
attributes:
label: Description
description: "A clear and concise description of what the problem is. ie: I'm always frustrated when [...]"
validations:
required: true
- type: textarea
id: proposed-solution
attributes:
label: Proposed Solution
description: "A clear and concise description of what you want to happen."
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Describe Alternatives You've Considered
description: "A clear and concise description of any alternative solutions or features you've considered."
validations:
required: true
- type: textarea
id: other-context
attributes:
label: Additional Context
description: "Add any other context or screenshots about the feature request here."

0 comments on commit 638c2ea

Please sign in to comment.