Skip to content

Commit 1453064

Browse files
chore: adding issues templates (#313)
closes #311 ### Description of changes: This PR adds issues templates. By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
1 parent dbb1ad7 commit 1453064

File tree

4 files changed

+214
-0
lines changed

4 files changed

+214
-0
lines changed
Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
name: 🐛 Bug Report
2+
description: Report a bug or unexpected behavior
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for reporting a bug! Please fill out the information below.
10+
11+
- type: input
12+
id: title
13+
attributes:
14+
label: Title
15+
description: Brief description of the bug
16+
placeholder: e.g., SDK fails when...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: expected
22+
attributes:
23+
label: Expected Behavior
24+
description: What did you expect to happen?
25+
placeholder: I expected...
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: actual
31+
attributes:
32+
label: Actual Behavior
33+
description: What actually happened?
34+
placeholder: Instead, what happened was...
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
id: reproduce
40+
attributes:
41+
label: Steps to Reproduce
42+
description: Provide steps to reproduce the issue
43+
placeholder: |
44+
1.
45+
2.
46+
3.
47+
validations:
48+
required: true
49+
50+
- type: input
51+
id: sdk-version
52+
attributes:
53+
label: SDK Version
54+
description: What version of the SDK are you using?
55+
placeholder: e.g., 1.0.0
56+
validations:
57+
required: true
58+
59+
- type: dropdown
60+
id: node-version
61+
attributes:
62+
label: Node.js Version
63+
description: What version of Node.js are you using?
64+
options:
65+
- "22.x"
66+
- "24.x"
67+
- Other (specify in additional context)
68+
validations:
69+
required: true
70+
71+
- type: dropdown
72+
id: regression
73+
attributes:
74+
label: Is this a regression?
75+
description: Did this work in a previous version?
76+
options:
77+
- "No"
78+
- "Yes"
79+
validations:
80+
required: true
81+
82+
- type: input
83+
id: worked-version
84+
attributes:
85+
label: Last Working Version
86+
description: If this is a regression, what version did this work in?
87+
placeholder: e.g., 0.9.0
88+
validations:
89+
required: false
90+
91+
- type: textarea
92+
id: context
93+
attributes:
94+
label: Additional Context
95+
description: Add any other context, logs, or screenshots
96+
placeholder: Additional information...
97+
validations:
98+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Ask a question
4+
url: https://github.com/aws/aws-durable-execution-sdk-js/discussions/new
5+
about: Ask a general question about Durable Functions JS SDK
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: 📚 Documentation Issue
2+
description: Report an issue with documentation
3+
title: "[Docs]: "
4+
labels: ["documentation"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for helping improve our documentation!
10+
11+
- type: input
12+
id: title
13+
attributes:
14+
label: Title
15+
description: Brief description of the documentation issue
16+
placeholder: e.g., Missing information about...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: issue
22+
attributes:
23+
label: Issue
24+
description: Describe the documentation issue
25+
placeholder: The documentation says... but it should say...
26+
validations:
27+
required: true
28+
29+
- type: input
30+
id: page
31+
attributes:
32+
label: Page/Location
33+
description: Link to the page or specify where in the docs this occurs
34+
placeholder: https://... or README.md section "..."
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
id: fix
40+
attributes:
41+
label: Suggested Fix
42+
description: How should this be corrected?
43+
placeholder: This could be fixed by...
44+
validations:
45+
required: false
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
name: ✨ Feature Request
2+
description: Suggest a new feature or enhancement
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to suggest a new feature!
10+
11+
- type: input
12+
id: title
13+
attributes:
14+
label: Title
15+
description: Brief description of the feature
16+
placeholder: e.g., Add support for...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: what
22+
attributes:
23+
label: What would you like?
24+
description: Describe the feature you'd like to see
25+
placeholder: I would like to...
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: implementation
31+
attributes:
32+
label: Possible Implementation
33+
description: Suggest how this could be implemented
34+
placeholder: This could be implemented by...
35+
validations:
36+
required: false
37+
38+
- type: dropdown
39+
id: breaking-change
40+
attributes:
41+
label: Is this a breaking change?
42+
options:
43+
- "No"
44+
- "Yes"
45+
validations:
46+
required: true
47+
48+
- type: dropdown
49+
id: rfc
50+
attributes:
51+
label: Does this require an RFC?
52+
description: RFC is required when changing existing behavior or for new features that require research
53+
options:
54+
- "No"
55+
- "Yes"
56+
validations:
57+
required: true
58+
59+
- type: textarea
60+
id: context
61+
attributes:
62+
label: Additional Context
63+
description: Add any other context, examples, or screenshots
64+
placeholder: Additional information...
65+
validations:
66+
required: false

0 commit comments

Comments
 (0)