Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Auto merge of #2496 - puremourning:update-issue-template, r=micbou
[READY] Improve issue template - guide the user in completing it # PR Prelude Thank you for working on YCM! :) **Please complete these steps and check these boxes (by putting an `x` inside the brackets) _before_ filing your PR:** - [X] I have read and understood YCM's [CONTRIBUTING][cont] document. - [X] I have read and understood YCM's [CODE_OF_CONDUCT][code] document. - [X] I have included tests for the changes in my PR. If not, I have included a rationale for why I haven't. > project administration-only change - [X] **I understand my PR may be closed if it becomes obvious I didn't actually perform all of these steps.** # Why this change is necessary and useful The issue template has worked very well and a larger number of reported issues include useful diagnostics. However, this is still far from ubiquitous. I've noticed two recurring problems, that I've tried to solve with an update to the template: - when reporting a build failure, not including the _entire_ `install.py` log or the command used to run it - when reporting issues, stating that something doesn't work, but not stating what the expected behaviour was (this is a common human mistake). Meanwhile, I've encouraged the reporter to fill in the sections by actually providing such sections in the template for them to fill in. This is unlikely to get us to 100%, but hopefully another incremental increase in the quality of reports will come out of it. [cont]: https://github.com/Valloric/YouCompleteMe/blob/master/CONTRIBUTING.md [code]: https://github.com/Valloric/YouCompleteMe/blob/master/CODE_OF_CONDUCT.md <!-- Reviewable:start --> --- This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/valloric/youcompleteme/2496) <!-- Reviewable:end -->
- Loading branch information