Skip to content

Commit 51f60fe

Browse files
tilyupotilyupo
committed
chore: add issue template
1 parent 6b17a60 commit 51f60fe

3 files changed

Lines changed: 215 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
name: Bug Report
2+
description: Report a bug or unexpected behavior in the Replane JavaScript SDK
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a bug! Please fill out the form below to help us understand and fix the issue.
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Description
15+
description: A clear and concise description of the bug.
16+
placeholder: What happened?
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: steps
22+
attributes:
23+
label: Steps to Reproduce
24+
description: Steps to reproduce the behavior.
25+
placeholder: |
26+
1. Initialize client with '...'
27+
2. Call method '...'
28+
3. See error
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: expected
34+
attributes:
35+
label: Expected Behavior
36+
description: What did you expect to happen?
37+
placeholder: What should have happened?
38+
validations:
39+
required: true
40+
41+
- type: dropdown
42+
id: package
43+
attributes:
44+
label: Package
45+
description: Which package are you using?
46+
options:
47+
- "@replanejs/sdk"
48+
- "@replanejs/react"
49+
- "@replanejs/next"
50+
- "@replanejs/svelte"
51+
- Multiple packages
52+
validations:
53+
required: true
54+
55+
- type: input
56+
id: package-version
57+
attributes:
58+
label: Package Version
59+
description: What version of the package are you using?
60+
placeholder: "e.g., 0.1.0"
61+
validations:
62+
required: true
63+
64+
- type: dropdown
65+
id: runtime
66+
attributes:
67+
label: Runtime Environment
68+
description: Where are you running the code?
69+
options:
70+
- Node.js
71+
- Bun
72+
- Deno
73+
- Browser
74+
- Next.js (Server)
75+
- Next.js (Client)
76+
- Other
77+
validations:
78+
required: true
79+
80+
- type: input
81+
id: runtime-version
82+
attributes:
83+
label: Runtime Version
84+
description: What version of the runtime are you using?
85+
placeholder: "e.g., Node.js 20.10.0"
86+
validations:
87+
required: false
88+
89+
- type: textarea
90+
id: environment
91+
attributes:
92+
label: Environment
93+
description: Any relevant environment details (OS, framework versions, bundler, etc.)
94+
placeholder: |
95+
- OS: macOS 14
96+
- Framework: Next.js 14 / React 18
97+
- Bundler: Vite / Webpack
98+
validations:
99+
required: false
100+
101+
- type: textarea
102+
id: code
103+
attributes:
104+
label: Code Sample
105+
description: Minimal code to reproduce the issue.
106+
render: typescript
107+
validations:
108+
required: false
109+
110+
- type: textarea
111+
id: logs
112+
attributes:
113+
label: Error Output / Logs
114+
description: Please copy and paste any relevant error messages or logs.
115+
render: shell
116+
validations:
117+
required: false
118+
119+
- type: textarea
120+
id: context
121+
attributes:
122+
label: Additional Context
123+
description: Add any other context about the problem here.
124+
validations:
125+
required: false
126+

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Community Discussions
4+
url: https://github.com/orgs/replane-dev/discussions
5+
about: Ask questions and discuss ideas with the community
6+
- name: Documentation
7+
url: https://replane.dev/docs/sdk/javascript
8+
about: Check the JavaScript SDK documentation
9+

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
name: Feature Request
2+
description: Suggest a new feature or enhancement for the Replane JavaScript SDK
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting a feature! Please fill out the form below to help us understand your idea.
10+
11+
- type: textarea
12+
id: problem
13+
attributes:
14+
label: Problem Statement
15+
description: Is your feature request related to a problem? Please describe.
16+
placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: solution
22+
attributes:
23+
label: Proposed Solution
24+
description: Describe the solution you'd like.
25+
placeholder: A clear and concise description of what you want to happen.
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: alternatives
31+
attributes:
32+
label: Alternatives Considered
33+
description: Describe any alternative solutions or features you've considered.
34+
placeholder: Other approaches you've thought about.
35+
validations:
36+
required: false
37+
38+
- type: dropdown
39+
id: package
40+
attributes:
41+
label: Related Package
42+
description: Which package does this feature relate to?
43+
options:
44+
- "@replanejs/sdk"
45+
- "@replanejs/react"
46+
- "@replanejs/next"
47+
- "@replanejs/svelte"
48+
- New package
49+
- All packages
50+
validations:
51+
required: true
52+
53+
- type: dropdown
54+
id: area
55+
attributes:
56+
label: Feature Area
57+
description: Which area of the SDK does this feature relate to?
58+
options:
59+
- Core Client
60+
- SSE / Real-time Updates
61+
- React Hooks
62+
- React Context
63+
- Next.js SSR/SSG
64+
- Svelte Stores
65+
- Override Evaluation
66+
- TypeScript Types
67+
- Error Handling
68+
- Documentation
69+
- Other
70+
validations:
71+
required: true
72+
73+
- type: textarea
74+
id: context
75+
attributes:
76+
label: Additional Context
77+
description: Add any other context or code examples about the feature request here.
78+
validations:
79+
required: false
80+

0 commit comments

Comments
 (0)