]> granicus.if.org Git - vim/commitdiff
patch 8.1.1070: issue templates are not good enough v8.1.1070
authorBram Moolenaar <Bram@vim.org>
Fri, 29 Mar 2019 12:12:39 +0000 (13:12 +0100)
committerBram Moolenaar <Bram@vim.org>
Fri, 29 Mar 2019 12:12:39 +0000 (13:12 +0100)
Problem:    Issue templates are not good enough.
Solution:   Rephrase to anticipate unexperienced users.

.github/ISSUE_TEMPLATE/bug_report.md
.github/ISSUE_TEMPLATE/feature_request.md
src/version.c

index a0d87dcca5c74835ab3e39c25b51d70b54e2b9ea..eb9ae4d0ce8bbb038d4d3a391d11df3c27a79994 100644 (file)
@@ -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.
index e85bf8a83132572b604240a57fc848f109206869..f78a84b56727bc9c25984b2a24f40b4e19ac6e99 100644 (file)
@@ -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.
index f471208af5dba9e1e8137e5281a5979ac7c2fc62..94fb6f6fa6e3ca828670926a3f4b093a0848e9ba 100644 (file)
@@ -775,6 +775,8 @@ static char *(features[]) =
 
 static int included_patches[] =
 {   /* Add new patch number below this line */
+/**/
+    1070,
 /**/
     1069,
 /**/