summary refs log tree commit diff
path: root/ISSUE_TEMPLATE.md
diff options
context:
space:
mode:
authorTom Lant <lampholder@gmail.com>2017-08-14 14:35:25 +0100
committerGitHub <noreply@github.com>2017-08-14 14:35:25 +0100
commit09703609fc2432ecf086b8fe45d6b324c5a923c9 (patch)
treeb18a82b47b8fdb460f4afb4672169f92b1f90c60 /ISSUE_TEMPLATE.md
parentMerge branch 'hotfixes-v0.22.1' of github.com:matrix-org/synapse (diff)
downloadsynapse-09703609fc2432ecf086b8fe45d6b324c5a923c9.tar.xz
Create ISSUE_TEMPLATE.md
A new issue template proposed to try and steer people towards #matrix:matrix.org for support queries relating to running their own homeserver.
Diffstat (limited to '')
-rw-r--r--ISSUE_TEMPLATE.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md
new file mode 100644
index 0000000000..61d8b59eb0
--- /dev/null
+++ b/ISSUE_TEMPLATE.md
@@ -0,0 +1,36 @@
+<!-- 
+
+**IF YOU HAVE SUPPORT QUESTIONS ABOUT RUNNING OR CONFIGURING YOUR OWN HOME SERVER**: 
+PLease don't file a bug; you will likely get better support more quickly if you 
+ask in #matrix:matrix.org ;)
+
+
+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.
+
+### Version information
+
+<!-- IMPORTANT: please answer the following questions, to help us narrow down the problem -->
+
+- **Homeserver**: was this issue identified on matrix.org or another homeserver?
+- **Platform**:   tell us about the environment in which your homeserver is operating
+                  - distro, hardware, if it's running in a vm/container, etc.