Karl/BobStore
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add reporting issues to CONTRIBUTING

Browse Source
This commit is contained in:
Daniel Martí 2015-08-26 20:05:52 -07:00
parent e7c727f446
commit 142db699a4
1 changed files with 19 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
CONTRIBUTING.md
View File

@ -1,20 +1,31 @@
Contributing 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 Style
----- -----
We follow the [Google Java style](https://google-styleguide.googlecode.com/svn/trunk/javaguide.html). We follow the [Google Java style](https://google-styleguide.googlecode.com/svn/trunk/javaguide.html).
To summarize it: To summarize it:
* Four space indentation * Four space indentation
* UTF-8 source files * UTF-8 source files
* Exactly one top-level class per file * Exactly one top-level class per file
* No wildcard imports * No wildcard imports
* One statement per line * One statement per line
* K&R spacings with braces and parenthesis * K&R spacings with braces and parenthesis
* Commented fallthroughs * Commented fallthroughs
* Braces are always used after if, for and while * Braces are always used after if, for and while
The current code base doesn't follow it entirely, but new code should follow The current code base doesn't follow it entirely, but new code should follow
it. it.