You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/bug_report.yml
+59-28Lines changed: 59 additions & 28 deletions
Original file line number
Diff line number
Diff line change
@@ -9,22 +9,29 @@ body:
9
9
value: |
10
10
**Before** reporting an issue, make sure to read the [documentation](https://codecompanion.olimorris.dev) and search [existing issues](https://github.com/olimorris/codecompanion.nvim/issues).
11
11
12
-
Usage questions such as ***"How do I...?"*** belong in [Discussions](https://github.com/olimorris/codecompanion.nvim/discussions) and will be closed.
12
+
**What is a bug?**
13
+
- A bug is a reproducible error that causes CodeCompanion to behave incorrectly, crash, or not work as documented.
14
+
- Minor cosmetic issues (such as extra line breaks or minor formatting quirks) are not considered bugs unless they impact usability or readability.
15
+
- Feature requests, usage questions, or configuration help should go to [Discussions](https://github.com/olimorris/codecompanion.nvim/discussions).
13
16
14
-
Finally, if you don't supply a valid `init.lua` file at the bottom of this page, your issue will be closed.
17
+
If you don't supply a valid `init.lua` file at the bottom of this page, your issue will be closed.
18
+
19
+
_Issues that do not follow this template, or are out of scope, may be closed without comment._
15
20
16
21
- type: checkboxes
17
22
attributes:
18
-
label: Did you check the docs and existing issues?
19
-
description: Make sure you checked all of the below before submitting an issue
23
+
label: Pre-submission checklist
24
+
description: Please confirm all of the following before submitting.
20
25
options:
21
-
- label: I have read all the docs
26
+
- label: I have read the documentation.
27
+
required: true
28
+
- label: I have updated CodeCompanion.nvim and all dependencies to the latest version.
22
29
required: true
23
-
- label: I have updated the plugin to the latest version before submitting this issue
30
+
- label: I have searched for existing issues and discussions.
24
31
required: true
25
-
- label: I have searched for existing issues/discussions
32
+
- label: I have checked related plugin issue trackers if relevant.
26
33
required: true
27
-
- label: I have searched the existing issues of plugins related to this issue
34
+
- label: My issue is not a minor or cosmetic quirk (e.g., formatting, spacing, or other non-functional details).
28
35
required: true
29
36
30
37
- type: input
@@ -33,56 +40,78 @@ body:
33
40
placeholder: "0.8.0 commit db1b0ee3b30f"
34
41
validations:
35
42
required: true
43
+
36
44
- type: input
37
45
attributes:
38
46
label: "Operating system/version"
39
-
placeholder: "MacOS 11.5"
47
+
placeholder: "macOS 14.4, Ubuntu 22.04, Windows 11"
40
48
validations:
41
49
required: true
50
+
42
51
- type: input
43
52
attributes:
44
53
label: "Adapter and model"
45
54
placeholder: "Copilot and GPT-4.1"
46
55
validations:
47
56
required: true
48
57
49
-
50
58
- type: textarea
51
59
attributes:
52
60
label: Describe the bug
53
-
description: A clear and concise description of what the bug is. Please include any related errors you see in Neovim.
61
+
description: |
62
+
A clear and concise description of the problem.
63
+
Include any error messages or unexpected behavior you observe.
64
+
placeholder: |
65
+
When I ...
66
+
I expected ...
67
+
Instead ...
54
68
validations:
55
69
required: true
70
+
56
71
- type: textarea
57
72
attributes:
58
-
label: Steps To Reproduce
59
-
description: Steps to reproduce the behavior.
73
+
label: Steps to reproduce
74
+
description: |
75
+
List the steps to reproduce the issue.
76
+
Be as minimal and precise as possible.
60
77
placeholder: |
61
-
1.
62
-
2.
63
-
3.
78
+
1. Open Neovim with the provided init.lua
79
+
2. ...
80
+
3. ...
64
81
validations:
65
82
required: true
83
+
66
84
- type: textarea
67
85
attributes:
68
-
label: Expected Behavior
69
-
description: A concise description of what you expected to happen.
86
+
label: Expected behavior
87
+
description: What did you expect to happen?
88
+
placeholder: |
89
+
I expected ...
70
90
validations:
71
91
required: true
72
92
93
+
- type: textarea
94
+
attributes:
95
+
label: Screenshots or recordings (optional)
96
+
description: If applicable, add screenshots or a screen recording to help explain your problem.
97
+
validations:
98
+
required: false
99
+
73
100
- type: markdown
74
101
attributes:
75
102
value: |
76
-
## Reproduce
77
-
78
-
Please provide the necessary config so I can recreate this issue. It's a big ask of my time as a single maintainer to investigate all possible issues that a user is experiencing.
103
+
## Minimal Reproduction
79
104
80
-
Use the template `init.lua` file provided to you below. A minimal config will be created for you in your working directory under `.repro`.
105
+
Please provide a minimal `init.lua` file that reproduces the issue.
106
+
Save as `init.lua` and run with `nvim -u init.lua`.
107
+
A minimal config will be created for you in your working directory under `.repro`.
81
108
82
109
- type: textarea
83
110
attributes:
84
111
label: init.lua file
85
-
description: Minimal file to reproduce this issue. Save as `init.lua` and run with `nvim -u init.lua`
112
+
description: |
113
+
Paste your minimal `init.lua` here.
114
+
Issues without a working minimal config will be closed.
86
115
value: |
87
116
--[[
88
117
NOTE: Set the config path to enable the copilot adapter to work.
@@ -170,16 +199,18 @@ body:
170
199
171
200
- type: textarea
172
201
attributes:
173
-
label: Log output
174
-
description: Share the output from the log file in your current working directory at `.repro/state/nvim/codecompanion.log`
202
+
label: Log output (optional)
203
+
description: |
204
+
Share the output from `.repro/state/nvim/codecompanion.log` if available.
205
+
Please redact any sensitive information.
175
206
validations:
176
207
required: false
177
208
178
209
- type: checkboxes
179
210
attributes:
180
-
label: Have you provided and tested with a repro.lua file?
181
-
description: I'll close this issue with no reason if I can't recreate it
211
+
label: Minimal reproduction confirmation
212
+
description: I have provided and tested with a minimal `init.lua` file as described above.
182
213
options:
183
-
- label: Yes, I have tested and provided a repro.lua file
214
+
- label: Yes, I have tested and provided a minimal `init.lua` file that reproduces the issue.
***adapters:** add tool support to Azure OpenAI ([#1737](https://github.com/olimorris/codecompanion.nvim/issues/1737)) ([2c7e9b1](https://github.com/olimorris/codecompanion.nvim/commit/2c7e9b1aa9fa1f5a2b4d82f3f4e065cb0c8bc2b7))
***tools:** patching for empty and small files with insufficient context ([#1734](https://github.com/olimorris/codecompanion.nvim/issues/1734)) ([cb55ef0](https://github.com/olimorris/codecompanion.nvim/commit/cb55ef006be3e75015c84fbd9adef14b3546a08f))
15
+
16
+
17
+
### Code Refactoring
18
+
19
+
***chat:** tools and variables now use `@{tool}` and `#{variable}` syntax ([#1740](https://github.com/olimorris/codecompanion.nvim/issues/1740)) ([f89eca2](https://github.com/olimorris/codecompanion.nvim/commit/f89eca26368b29bc8259921d459c1b4e5bfaeebb))
***adapters:**:boom: add tool support to Ollama ([#1585](https://github.com/olimorris/codecompanion.nvim/issues/1585)) ([e325370](https://github.com/olimorris/codecompanion.nvim/commit/e325370b8325697cb2f6becd13f267e6a12a0393))
27
+
28
+
29
+
### Bug Fixes
30
+
31
+
***workspace:** add description to buffer content ([#1713](https://github.com/olimorris/codecompanion.nvim/issues/1713)) ([ff939d1](https://github.com/olimorris/codecompanion.nvim/commit/ff939d18d8d64b0bef985aeb9be26f57e4ee8837))
***workspaces:** files can be opened as buffers ([#1708](https://github.com/olimorris/codecompanion.nvim/issues/1708)) ([2ea49ff](https://github.com/olimorris/codecompanion.nvim/commit/2ea49ff2063100757e71b0e327b7a32a1d566a9d))
***tools:** patching algorithm can start with an empty line ([#1663](https://github.com/olimorris/codecompanion.nvim/issues/1663)) ([370ec56](https://github.com/olimorris/codecompanion.nvim/commit/370ec56f388fd317fd324d68709e9441d3461896))
52
+
***tools:** patching algorithm now supports lines starting with `-` ([#1654](https://github.com/olimorris/codecompanion.nvim/issues/1654)) ([9011839](https://github.com/olimorris/codecompanion.nvim/commit/9011839a6827b264d632822d9ce17cb66fe95e61))
0 commit comments