8000 Clean up issue filing template · macvim-dev/macvim@02240c9 · GitHub
[go: up one dir, main page]
8000 Skip to content

Commit 02240c9

Browse files
ychinychin
committed
Clean up issue filing template
Clean up typos and make the descriptions clearer. Remove some unnecessary checkboxes and make some fields more specific to MacVim. Also make it clear that Vim issues should be filed upstream.
1 parent a4466fe commit 02240c9

File tree

1 file changed

+22
-28
lines changed

1 file changed

+22
-28
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 22 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ body:
1010
Thanks for reporting issues of MacVim!
1111
1212
If you want to report a security issue, instead of reporting it here publicly, please disclose it using the steps listed at https://github.com/macvim-dev/macvim/security/policy.
13+
14+
For general Vim issues that are not specific to MacVim, please file them at https://github.com/vim/vim.
1315
1416
To make it easier for us to help you please enter detailed information below.
1517
- type: textarea
@@ -30,56 +32,48 @@ body:
3032
required: true
3133
- type: input
3234
attributes:
33-
label: Version of Vim and architecture
35+
label: Version of MacVim
3436
description: >
35-
Including patch level, use ":version" to see it [e.g. 8.2.1234, GUI, arm64]
37+
MacVim release number (e.g. r181). Use "About MacVim" to find out which one you are using. If building manually from source, provide the Git commit hash instead (e.g. a4466fe3b695).
3638
validations:
3739
required: true
40+
- type: input
41+
attributes:
42+
label: MacVim installation method
43+
description: >
44+
Was MacVim downloaded from GitHub release, installed via Homebrew / Homebrew Cask / MacPorts, or built from source manually?
3845
- type: textarea
3946
attributes:
4047
label: Environment
4148
description: >
42-
OS and architecture [e.g. Big Sur, arm64], terminal [e.g. Apple Terminal/iTerm], value of $TERM, shell [e.g. zsh 5.8]; anything that might matter
49+
macOS version (e.g. macOS 15.3.2 Sequoia), Mac type (e.g. MacBook Air M2), terminal (e.g. Apple Terminal/iTerm); anything that might matter
4350
placeholder: |
44-
Operating system:
51+
macOS version:
52+
Mac:
4553
Terminal:
46-
Value of $TERM:
47-
Shell:
4854
validations:
4955
required: true
50-
- type: input
51-
attributes:
52-
label: How MacVim was installed
53-
description: >
54-
MacVim has been downloaded from GitHub, installed via Homebrew, MacPorts or builed from git
5556
- type: textarea
5657
attributes:
5758
label: Logs and stack traces
5859
placeholder: Insert log or other text here (if necessary)
5960
render: shell
60-
- type: input
61+
- type: textarea
6162
attributes:
62-
label: Vim configuration where issue is reproducable
63-
description: 'e.g. link to your vimrc configuration: url to file/gist/repo..'
63+
label: Vim and MacVim configuration where issue is reproducable
64+
description: Provide a link to vimrc and/or MacVim settings (see https://github.com/macvim-dev/macvim/wiki/Reporting-an-Issue for how to obtain it).
6465
- type: checkboxes
6566
attributes:
66-
label: Issue has been tested with given configuration
67-
description: This will help us to narrow down the problem more quickly
67+
label: How was MacVim launched?
68+
description: Different ways of opening MacVim can have an impact on the behavior.
6869
options:
69-
- label: by running MacVim.app from GUI macOS interface
70-
- label: by running vim/gvim/etc installed by MacVim
71-
- label: by running other versions of vim (e.g. /usr/bin/vim)
70+
- label: by launching MacVim.app in macOS (by using the Dock, Spotlight, or the `open` command)
71+
- label: by running mvim/gvim in the terminal
7272
- type: checkboxes
7373
attributes:
74-
label: Issue has been tested with no configuration
75-
description: This will help us to narrow down the problem more quickly
74+
label: Issue has been tested with clean configuration
75+
description: Running MacVim and Vim with clean configurations allow us to narrow down whether this is a configuration issue.
7676
options:
77-
- label: by running `mvim --clean` (or `gvim`, supplied by MacVim distribution)
77+
- label: by running `mvim --clean` (or `gvim`, supplied by MacVim distribution). You can also use the File → "New Clean Window" menu item within MacVim.
7878
- label: by running `vim --clean` (in terminal, supplied by MacVim distribution)
7979
- label: by running `vim --clean` (in terminal, other suppliers, e.g. /usr/bin/vim)
80-
- type: checkboxes
81-
attributes:
82-
label: Other conditions
83-
description: This will help us to narrow down the problem more quickly
84-
options:
85-
- label: The both Homebrew packages "vim" and "macvim" are installed

0 commit comments

Comments
 (0)
0