about summary refs log tree commit diff stats
path: root/.github
diff options
context:
space:
mode:
authorhut <hut@lepus.uberspace.de>2016-08-27 00:04:00 +0200
committerhut <hut@lepus.uberspace.de>2016-08-27 00:04:19 +0200
commit0757fe98dcb238133dcac664c972bdecb7b78b65 (patch)
tree63c4ffdb878d4df5f5d97f8548a5366a970f9352 /.github
parentb5ed90134fa9fce00231f11b8899e9184272d113 (diff)
downloadranger-0757fe98dcb238133dcac664c972bdecb7b78b65.tar.gz
Add github issue/PR templates
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE.md5
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md9
2 files changed, 14 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 00000000..77eb2a81
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,5 @@
+* 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
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 00000000..1aa748ad
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,9 @@
+* Use syntax compatible to both python 2.6+ and 3.1+.
+* Use docstrings with pydoc in mind
+* Follow the style guide for python code:
+    http://www.python.org/dev/peps/pep-0008/
+* Test the code with "doctest" where it makes sense
+* when breaking backward compatibility with old configuration files or plugins,
+  please include a temporary workaround code that provides a compatibility
+  layer and mark it with a comment that includes the word "COMPAT".  For
+  examples, grep the code for the word "COMPAT". :)