summaryrefslogtreecommitdiff
path: root/.github/ISSUE_TEMPLATE
diff options
context:
space:
mode:
authorBram Moolenaar <Bram@vim.org>2019-03-29 13:12:39 +0100
committerBram Moolenaar <Bram@vim.org>2019-03-29 13:12:39 +0100
commite46736b23b7cc25b914415fe4ceb851504f5419c (patch)
tree662b3649d9e0e8a5afa70a768900afd99be95ede /.github/ISSUE_TEMPLATE
parent8ac8a77f24098b58316bbfdf2f6c2c3f7f2b35c2 (diff)
downloadvim-git-e46736b23b7cc25b914415fe4ceb851504f5419c.tar.gz
patch 8.1.1070: issue templates are not good enoughv8.1.1070
Problem: Issue templates are not good enough. Solution: Rephrase to anticipate unexperienced users.
Diffstat (limited to '.github/ISSUE_TEMPLATE')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md19
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.md10
2 files changed, 17 insertions, 12 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index a0d87dcca..eb9ae4d0c 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,31 +1,34 @@
---
name: Bug report
-about: Create a report to help us improve
+about: Create a report to help us improve Vim
title: ''
labels: ''
---
+_Instructions: Replace the template text and remove irrelevant text (including this line)_
+
**Describe the bug**
A clear and concise description of what the bug is.
-(Issues related to the runtime files should be reported to the each maintainer. Not here.)
+(Issues related to the runtime files should be reported to their maintainer, check the file header.)
**To Reproduce**
-Steps to reproduce the behavior:
+Detailed steps to reproduce the behavior:
1. Run `vim --clean` (or `gvim --clean`, etc.)
-2. Type '....'
-3. See error
+2. Edit `filename`
+3. Type '....'
+4. Describe the error
**Expected behavior**
A clear and concise description of what you expected to happen.
**Screenshots**
-If applicable, add screenshots to help explain your problem.
+If applicable, copy/paste the text or add screenshots to help explain your problem.
**Environment (please complete the following information):**
- - Version [e.g. 8.1.1234] (Or paste the result of `vim --version`.)
+ - Vim version [e.g. 8.1.1234] (Or paste the result of `vim --version`.)
- OS: [e.g. Ubuntu 18.04, Windows 10 1809, macOS 10.14]
- - Terminal: [e.g. GNOME Terminal, mintty, iTerm2, tmux, GNU screen] (Use NONE if you use the GUI.)
+ - Terminal: [e.g. GNOME Terminal, mintty, iTerm2, tmux, GNU screen] (Use GUI if you use the GUI.)
**Additional context**
Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index e85bf8a83..f78a84b56 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,14 +1,16 @@
---
name: Feature request
-about: Suggest an idea for this project
+about: Suggest an enhancement for Vim
title: ''
labels: enhancement
---
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-(If it is related to runtime files, please discuss with the maintainer.)
+_Instructions: Replace the template text and remove irrelevant text (including this line)_
+
+**Is your feature request related something that is currently hard to do? Please describe.**
+A clear and concise description of what is hard to do. Ex. It is difficult to [...] when [...]
+(If it is related to runtime files, please check their header for where to discuss enhancements.)
**Describe the solution you'd like**
A clear and concise description of what you want to happen.