about summary refs log tree commit diff homepage
path: root/.github/ISSUE_TEMPLATE
diff options
context:
space:
mode:
authorCristian Cadar <c.cadar@imperial.ac.uk>2019-05-02 17:06:23 +0100
committerMartinNowack <martin.nowack@gmail.com>2019-05-07 10:52:48 +0100
commit0cf14d6d70b939ad29a9da42b33a4a5d4697b947 (patch)
tree6667df26f4bce32378c8df35721dbc96fcfc7090 /.github/ISSUE_TEMPLATE
parent385a29ea2f98738fb316a7e4875a5afd5597e9ae (diff)
downloadklee-0cf14d6d70b939ad29a9da42b33a4a5d4697b947.tar.gz
Update issue templates
Diffstat (limited to '.github/ISSUE_TEMPLATE')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md14
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.md14
-rw-r--r--.github/ISSUE_TEMPLATE/question.md15
3 files changed, 43 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 00000000..a33a5484
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,14 @@
+---
+name: Bug report
+about: Create a bug report to help us improve KLEE
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+If you found a bug in KLEE, please provide:
+1) A clear and concise description of what the bug is: what happened and what you expected to happen.
+2) Steps to reproduce the bug.  Ideally, you would provide a small code example triggering the bug and the exact command line used to run KLEE.  Please make sure the bug is still present in the mainline. 
+3) The warnings and error messages issued by KLEE
+4) Any relevant information about your platform: the output of `klee --version`, OS version, environment variables, directory in which KLEE is run, etc.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 00000000..681ffda5
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,14 @@
+---
+name: Feature request
+about: Suggest a feature in KLEE
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is.  E.g., I find it difficult to use KLEE when [...]; I would find it very useful for KLEE to [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
new file mode 100644
index 00000000..8b7c7c3a
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/question.md
@@ -0,0 +1,15 @@
+---
+name: Question
+about: Ask a question about KLEE
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+To ask a question about KLEE:
+1. Please first check the documentation at http://klee.github.io/docs/
+2. Then check the [searchable mailing list archive](https://www.mail-archive.com/klee-dev@imperial.ac.uk/)
+3. If this still doesn’t answer your questions then please send an email to the [klee-dev mailing list](http://klee.github.io/klee-dev/)
+
+**We will normally not answer questions asked on GitHub.**