Contributing guidelines

Contributions are very welcome. RunnerUp is open source software licensed under the GPL.

Development

Code style

Code should follow the Android Code Style Guidelines.

Tests

Unfortunately there are no tests in this project currently.

Previewing changes

Changes can be previewed using an emulator.

IDE

You may wish to consider Eclipse, Android Studio or NetBeans IDE.

To build the app using Android Studio, see this guide.

Making changes

Fork it ( https://github.com/jonasoreland/runnerup/fork )
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request

Where to start

Look at the TODO list
Write some tests
Help translating at https://www.transifex.com/organization/runner-up/dashboard

How to succeed in getting your Pull Request (PR) merged

Each PR should contain one logical change
Each PR should either contain 100% new code/features or be small enough so that it can be review quite quickly
If a PR gets to big, it should be split into several PRs, where e.g the first ones are refactorings needed later
Be sure only to modify lines you actually change. Keep reformattings and similar in separate PR.