Debian Codegraph @

.github/ISSUE_TEMPLATE/bug_report.yaml

raw
1 name: Bug report
2 description: Report a problem with Gitsigns
3 labels: [bug]
4 body:
5 - type: markdown
6 attributes:
7 value: >
8 Before reporting make sure that Gitsigns is updated to the latest version.
9
10 - type: textarea
11 attributes:
12 label: "Description"
13 description: "A comprehensive description of the problem you are reporting."
14 validations:
15 required: true
16
17 - type: input
18 attributes:
19 label: "Neovim version"
20 description: |
21 Output of `nvim --version`
22 validations:
23 required: true
24
25 - type: input
26 attributes:
27 label: "Operating system and version"
28 validations:
29 required: true
30
31 - type: textarea
32 attributes:
33 label: "Expected behavior"
34 description: "A description of the behavior you expected:"
35
36 - type: textarea
37 attributes:
38 label: "Actual behavior"
39 description: "Observed behavior (may optionally include logs, images, or videos)."
40 validations:
41 required: true
42
43 - type: textarea
44 attributes:
45 label: "Minimal config"
46 description: >
47 Minimal(!) configuration necessary to reproduce the issue. Save this as
48 `init.lua`.
49
50 Please **DO NOT** include a package manager (such as `lazy.nvim`) in this.
51
52 If this is not provided, the issue may be closed without notice.
53 render: Lua
54 value: |
55 for name, url in pairs{
56 gitsigns = 'https://github.com/lewis6991/gitsigns.nvim',
57 -- ADD OTHER PLUGINS _NECESSARY_ TO REPRODUCE THE ISSUE
58 } do
59 local install_path = vim.fn.fnamemodify('gitsigns_issue/'..name, ':p')
60 if vim.fn.isdirectory(install_path) == 0 then
61 vim.fn.system { 'git', 'clone', '--depth=1', url, install_path }
62 end
63 vim.opt.runtimepath:append(install_path)
64 end
65
66 require('gitsigns').setup{
67 debug_mode = true, -- You must add this to enable debug messages
68 -- ADD GITSIGNS CONFIG THAT IS _NECESSARY_ FOR REPRODUCING THE ISSUE
69 }
70
71 -- ADD INIT.LUA SETTINGS THAT IS _NECESSARY_ FOR REPRODUCING THE ISSUE
72 validations:
73 required: true
74
75 - type: textarea
76 attributes:
77 label: "Steps to reproduce"
78 description: >
79 Steps to reproduce using the minimal config provided.
80
81 If this is not provided, the issue may be closed without notice.
82
83 Example:
84 1. `mkdir gitsigns_issue`
85 2. `cd gitsigns_issue`
86 3. `git init`
87 4. `touch file`
88 5. `git add file`
89 6. `git commit -m 'initial commit'`
90 7. `nvim --clean -u init.lua file`
91 8. ...
92 validations:
93 required: true
94
95 - type: textarea
96 attributes:
97 label: "Gitsigns debug messages"
98 render: text
99 description: >
100 Please include the output of `:Gitsigns debug_messages`.
101
102 Note: You must have `debug_mode = true` in `setup()`.
103
104 - type: textarea
105 attributes:
106 label: "Gitsigns cache"
107 render: lua
108 description: >
109 If you think it's relevant maybe also provide the output of
110 `:Gitsigns dump_cache`.