Update HACKING, rename it to CONTRIBUTING

See #384
This commit is contained in:
Daniel Martí 2015-08-24 10:34:22 -07:00
parent 5c00c4463c
commit 888760e6ee
2 changed files with 27 additions and 38 deletions

27
CONTRIBUTING.md Normal file
View File

@ -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`

View File

@ -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`