summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorhut <hut@lepus.uberspace.de>2016-05-27 16:44:23 +0200
committerhut <hut@lepus.uberspace.de>2016-05-27 16:44:45 +0200
commitea355f491fb10d5ce054c7813d9abdfd3fc68991 (patch)
tree820c30c96acce485be49a718730c855294006d7a
parent513f7873de9ea8e40b662625ec8cc9bbb436fb2d (diff)
downloadranger-ea355f491fb10d5ce054c7813d9abdfd3fc68991.tar.gz
added CONTRIBUTING.md
this will be linked in github when users open PRs or issues
-rw-r--r--CONTRIBUTING.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..4c467c9c
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,15 @@
+# Contributing to Ranger
+
+## Tips for bug reports
+
+* You can obtain much better error messages with `ranger --debug`, please post
+  those in bug reports rather than the usual, single-line error message.
+* Please mention the version of ranger and Python
+* If possible, Please give step-by-step instructions to reproduce the bug.
+* Send security-relevant bugs PGP-encrypted to hut@hut.pm, see HACKING.md
+
+## Tips on patching
+
+* See HACKING.md
+
+Thank you!