Merge branch 'master' into readme-update

.github/ISSUE_TEMPLATE.md

@@ -17,7 +17,8 @@ the brackets) _before_ filing your issue:**
 - [ ] If filing a bug report, I have included which OS (including specific OS
   version) I am using.
 - [ ] If filing a bug report, I have included a minimal test case that reproduces
-  my issue, including what I expected to happen and what actually happened.
+  my issue, using `vim -Nu /path/to/YCM/vimrc_ycm_minimal`, including what I
+  expected to happen and what actually happened.
 - [ ] If filing a installation failure report, I have included the entire output
   of `install.py` (or `cmake`/`make`/`ninja`) including its invocation
 - [ ] **I understand this is an open-source project staffed by volunteers and
@@ -38,9 +39,19 @@ quickly and that neither your nor our time is needlessly wasted.
 
 > Include steps to reproduce here.
 
+1. `vim -Nu /path/to/YCM/ycm_vimrc_minimal`
+2. `:edit test.py`
+3. Enter insert mode and type `.....`
+
 > Include description of a minimal test case, including any actual code required
 > to reproduce the issue.
 
+> If you made changes to `vimrc_ycm_minimal`, pase them here:
+
+```
+<contents of ycm_vimrc_minimal>
+```
+
 * What did you expect to happen?
 
 > Include description of the expected behaviour.
@@ -54,17 +65,27 @@ quickly and that neither your nor our time is needlessly wasted.
 
 ## Output of `vim --version`
 
-> Place the output here, or a link to a [gist][].
+```
+Paste output here
+```
 
 ## Output of `YcmDebugInfo`
 
-> Place the output here, or a link to a [gist][].
+```
+Paste output here
+```
+
+## Output of `YcmDiags`
+
+```
+Paste output here
+```
 
 ## Contents of YCM, ycmd and completion engine logfiles
 
-> Add `let g:ycm_log_level = 'debug'` to vimrc, restart Vim, reproduce the
-> issue, and include link here to a [gist][] containing the entire logfiles for
-> ycm, ycmd and any completer logfiles listed by `:YcmToggleLogs`.
+> Reproduce the issue with `vim -Nu /path/to/YCM/vimrc_ycm_minimal`, which
+> enabled debug logging and other useful diagnostics.  Include a link to a
+> [gist][] containing all of the log files listed by `:YcmToggleLogs`.
 
 ## OS version, distribution, etc.
 

CONTRIBUTING.md

@@ -82,32 +82,31 @@ Here are the things you should do when creating an issue:
    issue. If you don't complete it in full, then the maintainers may elect to
    ignore or simply close your issue. This isn't personal, it's just that they
    are busy too.
-1. **Write a step-by-step procedure that when performed repeatedly reproduces
+2. **Check that your issue reproduces with a minimal configuration**. Run `vim
+   -Nu /path/to/YCM/vimrc_ycm_minimal` and reproduce this issue. If it doesn't
+   repro, then copy your ycm-specific settings into this file and try again. If
+   it still doesn't repro, the issue is likely with another plugin.
+3. **Write a step-by-step procedure that when performed repeatedly reproduces
    your issue.** If we can't reproduce the issue, then we can't fix it. It's
    that simple.
-2. Explain **what you expected to happen**, and **what actually happened**.
+4. Explain **what you expected to happen**, and **what actually happened**.
    This helps us understand if it is a bug, or just a misunderstanding of the
    behavior.
-2. Add the output of [the `:YcmDebugInfo` command][ycm-debug-info-command]. Make
+5. Add the output of [the `:YcmDebugInfo` command][ycm-debug-info-command]. Make
    sure that when you run this, your cursor is in the file that is experiencing
    the issue.
-3. Put the following options in your vimrc:
-   ```viml
-   let g:ycm_keep_logfiles = 1
-   let g:ycm_log_level = 'debug'
-   ```
-
-   Reproduce your issue and attach the contents of the logfiles. Use [the
+6. Reproduce your issue using `vim -Nu /path/to/YCM/vimrc_ycm_minimal` 
+    and attach the contents of the logfiles. Use [the
    `:YcmToggleLogs` command][ycm-toggle-logs-command] to directly open them in
    Vim.
-4. **Create a test case for your issue**. This is critical. Don't talk about how
+7. **Create a test case for your issue**. This is critical. Don't talk about how
    "when I have X in my file" or similar, _create a file with X in it_ and put
    the contents inside code blocks in your issue description. Try to make this
    test file _as small as possible_. Don't just paste a huge, 500 line source
    file you were editing and present that as a test. _Minimize_ the file so that
    the problem is reproduced with the smallest possible amount of test data.
-5. **Include your OS and OS version.**
-6. **Include the output of `vim --version`.**
+8. **Include your OS and OS version.**
+9. **Include the output of `vim --version`.**
 
 
 Creating good pull requests

vimrc_ycm_minimal

@@ -0,0 +1,12 @@
+" Enable debugging
+let g:ycm_keep_logfiles = 1
+let g:ycm_log_level = 'debug'
+
+" If the base settings don't repro, paste your existing config for YCM only,
+" here:
+" let g:ycm_....
+
+" Load YCM (only)
+let &rtp .= ',' . expand( '<sfile>:p:h' )
+filetype plugin indent on
+