Skip to content

Commit

Permalink
Replace issue template with issue forms [SDK-4196] (#1094)
Browse files Browse the repository at this point in the history
  • Loading branch information
Widcket committed May 4, 2023
1 parent 7e6d543 commit 79720c5
Show file tree
Hide file tree
Showing 5 changed files with 145 additions and 90 deletions.
91 changes: 91 additions & 0 deletions .github/ISSUE_TEMPLATE/Bug Report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
name: 🐞 Report a bug
description: Have you found a bug or issue? Create a bug report for this library
labels: ["bug"]

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: checklist
attributes:
label: Checklist
options:
- label: The issue can be reproduced in the [auth0-spa-js sample app](https://github.com/auth0-samples/auth0-javascript-samples/tree/master/01-Login) (or N/A).
required: true
- label: I have looked into the [Readme](https://github.com/auth0/auth0-spa-js#readme), [Examples](https://github.com/auth0/auth0-spa-js/blob/master/EXAMPLES.md), and [FAQ](https://github.com/auth0/auth0-spa-js/blob/master/FAQ.md) and have not found a suitable solution or answer.
required: true
- label: I have looked into the [documentation](https://auth0.com/docs/libraries/auth0-single-page-app-sdk) and [API documentation](https://auth0.github.io/auth0-spa-js/), and have not found a suitable solution or answer.
required: true
- label: I have searched the [issues](https://github.com/auth0/auth0-spa-js/issues) and have not found a suitable solution or answer.
required: true
- label: I have searched the [Auth0 Community](https://community.auth0.com) forums and have not found a suitable solution or answer.
required: true
- 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

- 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.
placeholder: |
1. Step 1...
2. Step 2...
3. ...
validations:
required: true

- type: textarea
id: additional-context
attributes:
label: Additional context
description: Other libraries that might be involved, or any other relevant information you think would be useful.
validations:
required: false

- type: input
id: environment-version
attributes:
label: auth0-spa-js version
validations:
required: true

- type: input
id: environment-framework
attributes:
label: Which framework are you using (React, Angular, Vue...)?
validations:
required: false

- type: input
id: environment-framework-version
attributes:
label: Framework version
validations:
required: false

- type: dropdown
id: environment-browser
attributes:
label: Which browsers have you tested in?
multiple: true
options:
- Chrome
- Edge
- Safari
- Firefox
- Opera
- Other
validations:
required: true
53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/Feature Request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: 🧩 Feature request
description: Suggest an idea or a feature for this library
labels: ["feature request"]

body:
- type: checkboxes
id: checklist
attributes:
label: Checklist
options:
- label: I have looked into the [Readme](https://github.com/auth0/auth0-spa-js#readme), [Examples](https://github.com/auth0/auth0-spa-js/blob/master/EXAMPLES.md), and [FAQ](https://github.com/auth0/auth0-spa-js/blob/master/FAQ.md) and have not found a suitable solution or answer.
required: true
- label: I have looked into the [documentation](https://auth0.com/docs/libraries/auth0-single-page-app-sdk) and [API documentation](https://auth0.github.io/auth0-spa-js/), and have not found a suitable solution or answer.
required: true
- label: I have searched the [issues](https://github.com/auth0/auth0-spa-js/issues) and have not found a suitable solution or answer.
required: true
- label: I have searched the [Auth0 Community](https://community.auth0.com) forums and have not found a suitable solution or answer.
required: true
- 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

- 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.
placeholder: 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
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
blank_issues_enabled: false
contact_links:
- name: Auth0 Community
url: https://community.auth0.com/tags/c/sdks/5/auth0-spa-js
url: https://community.auth0.com
about: Discuss this SDK in the Auth0 Community forums
- name: FAQ
url: https://github.com/auth0/auth0-spa-js/blob/master/FAQ.md
Expand Down
31 changes: 0 additions & 31 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

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

This file was deleted.

0 comments on commit 79720c5

Please sign in to comment.