From 142db699a42eec0a00e0f2db23858850d3ca5344 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Mart=C3=AD?= Date: Wed, 26 Aug 2015 20:05:52 -0700 Subject: [PATCH] Add reporting issues to CONTRIBUTING --- CONTRIBUTING.md | 27 +++++++++++++++++++-------- 1 file changed, 19 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2e468f42b..a45cbc3cb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,20 +1,31 @@ Contributing ============ +Reporting issues +---------------- + +Remember to include: + +* Android version +* Device model +* F-Droid version +* Steps to reproduce the issue +* Logcat - see [instructions](https://f-droid.org/wiki/page/Getting_logcat_messages_after_crash) + Style ----- We follow the [Google Java style](https://google-styleguide.googlecode.com/svn/trunk/javaguide.html). To summarize it: - * Four space indentation - * UTF-8 source files - * Exactly one top-level class per file - * No wildcard imports - * One statement per line - * K&R spacings with braces and parenthesis - * Commented fallthroughs - * Braces are always used after if, for and while +* Four space indentation +* UTF-8 source files +* Exactly one top-level class per file +* No wildcard imports +* One statement per line +* K&R spacings with braces and parenthesis +* Commented fallthroughs +* Braces are always used after if, for and while The current code base doesn't follow it entirely, but new code should follow it.