diff options
| -rw-r--r-- | CONTRIBUTING.md | 9 | ||||
| -rw-r--r-- | HACKING.md | 6 |
2 files changed, 8 insertions, 7 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a75afcae..abf25300 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,11 +2,12 @@ ## Tips for bug reports +* Always completely fill out the issue template that is automatically inserted + on issue creation. * 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` + those in bug reports rather than the usual, single-line error message. Also + check the log by using the default map `W` or by running the command `display_log`. +* Send security-relevant bugs PGP-encrypted to hut@hut.pm, see `HACKING.md`. ## Tips on patching diff --git a/HACKING.md b/HACKING.md index 68055555..b8f62d86 100644 --- a/HACKING.md +++ b/HACKING.md @@ -4,10 +4,10 @@ Guidelines for Code Modification Coding Style ------------ -* Use syntax compatible to both Python 2.6+ and 3.1+. +* Use syntax compatible with Python `2.6+` and `3.1+`. * Use docstrings with `pydoc` in mind -* Follow the style guide for python code: https://www.python.org/dev/peps/pep-0008/ -* Test the code with `doctest` where it makes sense +* Follow the PEP8 style guide: https://www.python.org/dev/peps/pep-0008/ +* Always run `make test` before submitting a new PR. `pylint` and `flake8` needs to be installed. * 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 |