From e271142804957f2932859140796ea15fef541d87 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Karl=20Yngve=20Lerv=C3=A5g?= Date: Sun, 21 Feb 2016 21:18:22 +0100 Subject: [PATCH] Add issue template --- ISSUE_TEMPLATE.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 ISSUE_TEMPLATE.md diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..5acaabf --- /dev/null +++ b/ISSUE_TEMPLATE.md @@ -0,0 +1,45 @@ +### Explain the issue + +Most issues are related to bugs or problems. In these cases, you should include +a minimal working example and a minimal vimrc file (see below), as well as: + +1. Steps to reproduce +2. Expected behaviour +3. Observed behaviour + +If your issue is instead a feature request or anything else, please consider if +minimal examples and vimrc files might still be relevant. + +### Minimal working example + +Please provide a minimal working LaTeX example, e.g. + +```tex +documentclass{minimal} +\begin{document} + +Hello World! + +\end{document} +``` + +### Minimal vimrc file + +Please provide a minimal vimrc file that reproduces the issue. The following +should often suffice: + +```vim +set nocompatible + +" Load Vimtex +let &rtp = '~/.vim/bundle/vimtex,' . &rtp +let &rtp .= ',~/.vim/bundle/vimtex/after' + +" Load other plugins, if necessary +" let &rtp = '~/path/to/other/plugin,' . &rtp + +filetype plugin indent on +syntax enable + +" Vimtex options go here +```