From 888760e6ee101abdcda92403dd68612804b76db5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Mart=C3=AD?= Date: Mon, 24 Aug 2015 10:34:22 -0700 Subject: [PATCH] Update HACKING, rename it to CONTRIBUTING See #384 --- CONTRIBUTING.md | 27 +++++++++++++++++++++++++++ HACKING.md | 38 -------------------------------------- 2 files changed, 27 insertions(+), 38 deletions(-) create mode 100644 CONTRIBUTING.md delete mode 100644 HACKING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..2e468f42b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,27 @@ +Contributing +============ + +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 + +The current code base doesn't follow it entirely, but new code should follow +it. + +Debugging +--------- + +To get all the logcat messages by F-Droid, you can run: + + adb logcat | grep `adb shell ps | grep org.fdroid.fdroid | cut -c10-15` diff --git a/HACKING.md b/HACKING.md deleted file mode 100644 index ee26f8798..000000000 --- a/HACKING.md +++ /dev/null @@ -1,38 +0,0 @@ -F-Droid Client Hacking Doc -========================== - -Style ------ - -We loosely follow the [Google Java style](https://google-styleguide.googlecode.com/svn/trunk/javaguide.html). -Some of the points we follow the most are: - - * 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 - -Some other interesting additions we might use in the future: - - * Commented fallthroughs - * Braces are always used after if, for and while - -We don't strictly follow the entire style spec, but when in doubt you should -follow it. - -Building --------- - -You have three options: - - * Build with gradle - * Build with gradle from source - -Debugging ---------- - -To get all the logcat messages by F-Droid, you can run: - - adb logcat | grep `adb shell ps | grep org.fdroid.fdroid | cut -c10-15`