aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDaniel Gultsch <daniel@gultsch.de>2016-05-13 08:59:43 +0200
committerDaniel Gultsch <daniel@gultsch.de>2016-05-13 08:59:43 +0200
commit72f541140fd931b5e6adc67ec1aa477175c760f2 (patch)
tree2e493b1473edaa535566a204a52041091ff20ee7
parentacad16134432e6d7a11602078aaa0884a70dce35 (diff)
create contributing guidelines
-rw-r--r--.github/CONTRIBUTING.md11
1 files changed, 11 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**