From 4047db2669e643fb3b1975a9f4f42e6c336adc26 Mon Sep 17 00:00:00 2001 From: Fangrui Song Date: Fri, 1 Mar 2019 17:37:37 -0800 Subject: [PATCH] Add .github/ISSUE_TEMPLATE Adapted from https://github.com/hlissner/doom-emacs --- .github/ISSUE_TEMPLATE | 36 ++++++++++++++++++++++++++++++++++++ .gitignore | 1 + 2 files changed, 37 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE diff --git a/.github/ISSUE_TEMPLATE b/.github/ISSUE_TEMPLATE new file mode 100644 index 00000000..1a27d017 --- /dev/null +++ b/.github/ISSUE_TEMPLATE @@ -0,0 +1,36 @@ +Here are some things you should try before filing a bug report: + ++ For client issues related to [emacs-ccls](https://github.com/MaskRay/emacs-ccls) or [vscode-ccls](https://github.com/MaskRay/vscode-ccls), report in their own repository. ++ For build problems, check https://github.com/MaskRay/ccls/wiki/Build ++ Check https://github.com/MaskRay/ccls/wiki/Debugging ++ Check [the FAQ](https://github.com/MaskRay/ccls/wiki/FAQ) to see if your issue is mentioned. + +If none of those help, remove this section and fill out the four sections in the template below. + +--- + +### Observed behavior + +Describe what happened. Any aids you can include (that you think could be relevant) are a tremendous help. + +* `compile_commands.json` or `.ccls` ([wiki/Project-Setup](https://github.com/MaskRay/ccls/wiki/Project-Setup)) +* Reduce to A minimal set of `.c` `.cc` `.h` `.hh` files that can still demonstrate the issue. +* Consider a screencast gif. + +### Expected behavior + +Describe what you expected to happen. + +### Steps to reproduce + +1. Select these example steps, +2. Delete them, +3. And replace them with precise steps to reproduce your issue. + +### System information + +* ccls version (`git describe --tags --long`): +* clang version: +* OS: +* Editor: +* Language client (and version): diff --git a/.gitignore b/.gitignore index 87cc1bce..6c3c5f19 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,4 @@ build debug release /compile_commands.json +!.github/