aboutsummaryrefslogtreecommitdiffstats
path: root/.github
diff options
context:
space:
mode:
Diffstat (limited to '.github')
-rw-r--r--.github/CONTRIBUTING.md11
-rw-r--r--.github/ISSUE_TEMPLATE.md29
2 files changed, 40 insertions, 0 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 00000000..c44dd479
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,11 @@
+### Reporting Bugs and getting help
+
+The issue tracker on Github is for bug reports only. It is not a general support forum.
+
+**A bug is everything you can reproduce. ie *if I do this that happens but something else should happen instead*.**
+
+Please search the issue tracker (including closed issues). Your bug might be a server bug that has already been addressed.
+
+Please fill in the template when creating new issues and provide information about your device and your server. The [adb logcat](https://wiki.cyanogenmod.org/w/Doc:_debugging_with_logcat) can be omitted if you can reproduce the bug under every condition. (ie *click button X and the application crashes*) But the adb logcat is required if the bug happens only under certain conditions or involves network problem (Server not found, messages not arriving)
+
+**If you are seeking help or are unable to reproduce the exact problem please join our MUC at conversations@conference.siacs.eu**
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 00000000..5e7c4400
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,29 @@
+#### General information
+
+* **Device:** eg Google Nexus 5
+* **Android Version:** eg Android 6.0 Stock or Android 5.1 Cyanogenmod
+* **Server name:** eg conversations.im, jabber.at or self hosted
+* **Server software:** ejabberd 16.04 or prosody 0.10 (if known)
+* **Installed server modules:** eg Stream Managment, CSI, MAM
+* **Conversations source:** eg PlayStore, PlayStore Beta Channel, F-Droid, self build (latest HEAD)
+
+
+#### Steps to reproduce
+
+1. …
+2. …
+
+
+#### Expected result
+
+What is the expected output? What do you see instead?
+
+
+#### Debug output
+
+Please post the output of adb logcat. The log should begin with the start of Conversations and include all the
+steps it takes to reproduce the problem.
+
+````
+adb logcat -s conversations
+````