From 5779b87549dff9c3e9d0221947ff4f1c70b54116 Mon Sep 17 00:00:00 2001 From: Christian Brabandt Date: Wed, 3 Feb 2016 11:39:14 +0100 Subject: [PATCH] initial version --- How-to-report-issues.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 How-to-report-issues.md diff --git a/How-to-report-issues.md b/How-to-report-issues.md new file mode 100644 index 0000000..a2b093f --- /dev/null +++ b/How-to-report-issues.md @@ -0,0 +1,7 @@ +* Search the existing [open](https://github.com/vim-airline/vim-airline/issues?q=is%3Aopen) and [closed](https://github.com/vim-airline/vim-airline/issues?q=is%3Aclosed) issues. Maybe the bug was already reported? +* Mention your terminal (if you use the terminal version), vim version, font used. Also terminal related things such as tmux/screen, $TERM, or similar things should be mentioned +* Describe your issue properly. If you spend 30 seconds throwing out a sloppy report, do expect that others will spend exactly the same amount on trying to resolve it. +* Include a [Minimal, Complete, and Verifiable example](http://stackoverflow.com/help/mcve) using GitHub Markdown's `codeblock` delimiters. +* Be prepared to test fixes! +* Be polite. You are asking highly competent software developers for help, for free, so you might want to avoid treating them as if they were a commodity or at your free disposal. +* For further inspiration, read reports that were resolved successfully, http://www.chiark.greenend.org.uk/~sgtatham/bugs.html, http://stackoverflow.com/questions/how-to-ask and http://whathaveyoutried.com/. \ No newline at end of file