Skip to content

Commit 4d8c18f

Browse files
brionmariobrionmario
committed
chore: add issue templates for bug reports, improvement requests, and new feature suggestions
1 parent bf70ae1 commit 4d8c18f

File tree

3 files changed

+181
-0
lines changed

3 files changed

+181
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug.yml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: "🐞 Report a Bug"
2+
description: Create an issue if something does not work as expected.
3+
labels: ["Type/Bug"]
4+
body:
5+
- type: textarea
6+
id: background
7+
attributes:
8+
label: Description
9+
description: Please share a clear and concise description of the problem.
10+
placeholder: Description
11+
- type: textarea
12+
id: steps
13+
attributes:
14+
label: Steps to Reproduce
15+
description: List the steps you followed when you encountered the issue.
16+
validations:
17+
required: true
18+
- type: dropdown
19+
id: area
20+
attributes:
21+
label: Please select the package issue is related to
22+
options:
23+
- '@asgardeo/browser'
24+
- '@asgardeo/express'
25+
- '@asgardeo/javascript'
26+
- '@asgardeo/nextjs'
27+
- '@asgardeo/node'
28+
- '@asgardeo/nuxt'
29+
- '@asgardeo/react'
30+
- '@asgardeo/react-router'
31+
- '@asgardeo/vue'
32+
- 'samples'
33+
default: 1
34+
multiple: true
35+
validations:
36+
required: true
37+
- type: input
38+
id: version
39+
attributes:
40+
label: Version
41+
description: Enter package version or commit hash.
42+
validations:
43+
required: true
44+
- type: textarea
45+
id: environment
46+
attributes:
47+
label: Environment Details (with versions)
48+
description: Mention the environment details (OS, Browser, etc..) that the SDK is running on.
49+
validations:
50+
required: false
51+
- type: checkboxes
52+
id: reporter-checklist
53+
attributes:
54+
label: Reporter Checklist
55+
description: Please ensure the following before submitting the issue.
56+
options:
57+
- label: "I have searched the existing issues and this is not a duplicate."
58+
required: true
59+
- label: "I have provided all the necessary information."
60+
required: true
61+
- label: "I have tested the issue on the latest version of the package."
62+
required: true

‎.github/ISSUE_TEMPLATE/improvement.yml‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: "🚀 Improvement Request"
2+
description: Suggest an improvement for the SDKs.
3+
labels: ["Type/Improvement"]
4+
body:
5+
- type: textarea
6+
id: limitation
7+
attributes:
8+
label: Current Limitation
9+
description: Describe the current limitation.
10+
validations:
11+
required: true
12+
- type: textarea
13+
id: suggestion
14+
attributes:
15+
label: Suggested Improvement
16+
description: Describe the improvement you suggest.
17+
validations:
18+
required: true
19+
- type: dropdown
20+
id: area
21+
attributes:
22+
label: Please select the package issue is related to
23+
options:
24+
- '@asgardeo/browser'
25+
- '@asgardeo/express'
26+
- '@asgardeo/javascript'
27+
- '@asgardeo/nextjs'
28+
- '@asgardeo/node'
29+
- '@asgardeo/nuxt'
30+
- '@asgardeo/react'
31+
- '@asgardeo/react-router'
32+
- '@asgardeo/vue'
33+
- 'samples'
34+
default: 1
35+
multiple: true
36+
validations:
37+
required: true
38+
- type: input
39+
id: version
40+
attributes:
41+
label: Version
42+
description: Enter package version or commit hash.
43+
validations:
44+
required: true
45+
- type: checkboxes
46+
id: reporter-checklist
47+
attributes:
48+
label: Reporter Checklist
49+
description: Please review and confirm the following items before opening the improvement request.
50+
options:
51+
- label: "I have searched the existing issues and this is not a duplicate."
52+
required: true
53+
- label: "I have provided all the necessary information."
54+
required: true
55+
- label: "I have verified the improvement is not available in the latest version of the package."
56+
required: true

‎.github/ISSUE_TEMPLATE/new_feature.yml‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: "💡 New Feature Request"
2+
description: Suggest new functionality and features for the SDKs.
3+
labels: ["Type/NewFeature"]
4+
body:
5+
- type: textarea
6+
id: problem
7+
attributes:
8+
label: Problem
9+
description: What is the problem this feature will solve?
10+
validations:
11+
required: true
12+
- type: textarea
13+
id: solution
14+
attributes:
15+
label: Proposed Solution
16+
description: Describe the solution you'd like to have.
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: alternatives
21+
attributes:
22+
label: Alternatives
23+
description: Describe any alternatives have you considered
24+
validations:
25+
required: false
26+
- type: dropdown
27+
id: area
28+
attributes:
29+
label: Please select the package issue is related to
30+
options:
31+
- '@asgardeo/browser'
32+
- '@asgardeo/express'
33+
- '@asgardeo/javascript'
34+
- '@asgardeo/nextjs'
35+
- '@asgardeo/node'
36+
- '@asgardeo/nuxt'
37+
- '@asgardeo/react'
38+
- '@asgardeo/react-router'
39+
- '@asgardeo/vue'
40+
- 'samples'
41+
default: 1
42+
multiple: true
43+
validations:
44+
required: true
45+
- type: input
46+
id: version
47+
attributes:
48+
label: Version
49+
description: Enter package version or commit hash.
50+
validations:
51+
required: true
52+
- type: checkboxes
53+
id: reporter-checklist
54+
attributes:
55+
label: Reporter Checklist
56+
description: Please review and confirm the following items before opening the feature request.
57+
options:
58+
- label: "I have searched the existing issues and this is not a duplicate."
59+
required: true
60+
- label: "I have provided all the necessary information."
61+
required: true
62+
- label: "I have verified the feature on the latest version of the package."
63+
required: true

0 commit comments

Comments
 (0)