ISSUE_TEMPLATE.md

1 files changed, 39 insertions, 0 deletions

diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md
new file mode 100644
index 00000000..64a80350
--- /dev/null
+++ b/ISSUE_TEMPLATE.md
@@ -0,0 +1,39 @@
+<!-- 
+
+This is a bug report template. By following the instructions below and
+filling out the sections with your information, you will help the us to get all
+the necessary data to fix your issue.
+
+You can also preview your report before submitting it. You may remove sections
+that aren't relevant to your particular case.
+
+Text between <!-- and --​> marks will be invisible in the report.
+
+-->
+
+### Description
+
+Describe here the problem that you are experiencing, or the feature you are requesting.
+
+### Steps to reproduce
+
+- For bugs, list the steps
+- that reproduce the bug
+- using hyphens as bullet points
+
+Describe how what happens differs from what you expected.
+
+libqmatrixclient-based clients either have a log file or dump log to the standard output.
+If you can identify any log snippets relevant to your issue, please include
+those here (please be careful to remove any personal or private data):
+
+### Version information
+
+<!-- IMPORTANT: please answer the following questions, to help us narrow down the problem -->
+
+- **The client application**: <!-- the problem might be not with the library but with the client -->
+- **libqmatrixclient version if you know it**: <!-- try to find it basing on the client version -->
+- **Qt version**: <!-- for Linux systems, it's usually installed system-wide; for other OSes,
+as well as Flatpak/AppImage/etc. containerised environments, it's a version used in the container. -->
+- **Install method**: <!-- package manager/Flatpak/archive downloaded (from which site?) -->
+- **Platform**: <!-- Operating system and anything about your platform you think can be relevant -->