Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SDK-3434] Update issues templates #140

Merged
merged 13 commits into from
Jun 16, 2022
86 changes: 86 additions & 0 deletions .github/ISSUE_TEMPLATE/Bug Report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
name: 🐞 Report a bug
description: Have you found a bug or issue? Create a bug report for this library

body:
- type: markdown
attributes:
value: |
**Please do not report security vulnerabilities here**. The [Responsible Disclosure Program](https://auth0.com/responsible-disclosure-policy) details the procedure for disclosing security issues.

- type: checkboxes
id: not-general-support
attributes:
label: This is not for general support and usage questions
options:
- label: I have looked into the [README](https://github.com/auth0/SimpleKeychain#readme) and have not found a suitable solution or answer.
required: true
- label: I have searched the [issues](https://github.com/auth0/SimpleKeychain/issues) and have not found a suitable solution or answer.
required: true
- label: I have searched the [Auth0 Community](https://community.auth0.com/tags/c/sdks/5/ios) forums and have not found a suitable solution or answer.
required: true

- type: textarea
id: description
attributes:
label: Description
description: Provide a clear and concise description of the issue, including what you expected to happen.
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Reproduction
description: Detail the steps taken to reproduce this error, and whether this issue can be reproduced consistently or if it is intermittent.
validations:
required: true

- type: input
id: environment-version
attributes:
label: SimpleKeychain version
validations:
required: true

- type: dropdown
id: environment-platform
attributes:
label: Platform
multiple: true
options:
- iOS
- macOS
- tvOS
- watchOS
validations:
required: true

- type: input
id: environment-platform-version
attributes:
label: Platform version(s)
validations:
required: true

- type: input
id: environment-xcode-version
attributes:
label: Xcode version
validations:
required: true

- type: input
id: environment-package-manager
attributes:
label: Package manager
placeholder: SPM, Cocoapods, Carthage, etc.
validations:
required: true

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
options:
- label: I agree to the terms within the [Auth0 Code of Conduct](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md).
evansims marked this conversation as resolved.
Show resolved Hide resolved
required: true
56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/Feature Request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: 🧩 Feature request
description: Suggest an idea or a feature for this library
labels: ["feature request"]

body:
- type: checkboxes
id: not-general-support
attributes:
label: This is not for general support and usage questions
options:
- label: I have looked into the [README](https://github.com/auth0/SimpleKeychain#readme) and have not found a suitable solution or answer.
required: true
- label: I have searched the [issues](https://github.com/auth0/SimpleKeychain/issues) and have not found a suitable solution or answer.
required: true
- label: I have searched the [Auth0 Community](https://community.auth0.com/tags/c/sdks/5/ios) forums and have not found a suitable solution or answer.
required: true

- type: textarea
id: description
attributes:
label: Describe the problem you'd like to have solved
description: A clear and concise description of what the problem is. For example, I'm always frustrated when...
validations:
required: true

- type: textarea
id: ideal-solution
attributes:
label: Describe the ideal solution
description: A clear and concise description of what you want to happen.
validations:
required: true

- type: textarea
id: alternatives-and-workarounds
attributes:
label: Alternatives and current workarounds
description: A clear and concise description of any alternatives you've considered or any workarounds that are currently in place.
validations:
required: false

- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
validations:
required: false

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
options:
evansims marked this conversation as resolved.
Show resolved Hide resolved
- label: I agree to the terms within the [Auth0 Code of Conduct](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md).
required: true
10 changes: 8 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: Auth0 Community
- name: 🤔 Help & Questions
url: https://community.auth0.com/tags/c/sdks/5/ios
about: Discuss this library in the Auth0 Community forums
about: Ask general support or usage questions in the Auth0 Community forums
- name: 🚀 Usage
url: https://github.com/auth0/SimpleKeychain#usage
about: Check the Usage section of the README to get up to speed with SimpleKeychain
- name: 📖 API Documentation
url: https://auth0.github.io/SimpleKeychain/
about: Check the public API documentation for in-depth overview of all the available features
27 changes: 0 additions & 27 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

44 changes: 0 additions & 44 deletions .github/ISSUE_TEMPLATE/report-a-bug.md

This file was deleted.