Skip to content

Commit ea24923

Browse files
authored
improve bug report issue template (CopilotKit#340)
improve bug report issue template
1 parent 4302953 commit ea24923

1 file changed

Lines changed: 52 additions & 10 deletions

File tree

Lines changed: 52 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
---
22
name: Bug report
33
about: Create a report to help us improve
4-
title: ''
4+
title: ""
55
labels: bug
6-
assignees: ''
7-
6+
assignees: ""
87
---
98

109
**Describe the bug**
1110
A clear and concise description of what the bug is.
1211

1312
**To Reproduce**
14-
Steps to reproduce the behavior:
13+
Steps to reproduce the behavior (the easier it is to replicate, the sooner it will get fixed):
14+
1515
1. Go to '...'
16-
2. Click on '....'
17-
3. Scroll down to '....'
16+
2. Click on '...'
17+
3. Scroll down to '...'
1818
4. See error
1919

2020
**Expected behavior**
@@ -23,8 +23,50 @@ A clear and concise description of what you expected to happen.
2323
**Screenshots**
2424
If applicable, add screenshots to help explain your problem.
2525

26-
** Browser (please complete the following information):**
27-
- OS / Browser [e.g. Mac / safari]
26+
**Environment:**
27+
28+
- OS/Browser: [e.g. MacOS/Safari, Windows/Chrome, iOS/Safari]
29+
- Runtime: [Copilot Cloud, self-hosted]
30+
- Frontend Framework: [e.g. Next, Remix]
31+
- Backend Framework (if self-hosted): [e.g. Next, Node, Firebase]
32+
33+
**CopilotKit Packages**
34+
Add the output of this command:
35+
36+
```sh
37+
cat **/package.json | grep "@copilotkit"
38+
```
39+
40+
**Frontend Code**
41+
Provide any code related to the issue, especially CopilotKit components and hooks.
42+
43+
```tsx
44+
<CopilotKit>
45+
<CopilotPopup instructions="...">
46+
...
47+
</CopilotPopup>
48+
</CopilotKit>
49+
50+
useCopilotReadable({
51+
description: "Your Description...",
52+
value: aValue,
53+
})
54+
55+
useCopilotAction({
56+
... your action config
57+
})
58+
```
59+
60+
**Backend Code**
61+
62+
If you self-host the runtime, please provide the relevant backend code.
63+
For example, provide your server side actions:
2864

29-
**Additional context**
30-
Add any other context about the problem here.
65+
```ts
66+
const copilotKit = new CopilotRuntime({
67+
actions: [
68+
// ... your actions
69+
],
70+
});
71+
// ... your server side code
72+
```

0 commit comments

Comments
 (0)