Developer documentation

How to contribute code

Building And Bible

1. Download and Install Android Studio.

2. Open a Terminal/command prompt.

3. Create a directory e.g. 'mydevdir' and change to that directory.

4. Run:

git clone https://github.com/AndBible/and-bible.git 

5. In Android Studio select File/Open. Then open the and-bible folder with a green compass icon under mydevdir/and-bible/and-bible.

While running And Bible in emulator, I'm using the following configuration:

Running tests

Configuration for running tests in Android Studio:

Contributing code

• Consider writing unit tests (whether it is very important or not depends on the type of code you write)
• Run tests and fix any that happen to be broken after your improvements
• Create pull request towards master branch

Code style guide

• Do not write too long lines (120 characters should be your guide)
• Preferrably write new code in Kotlin (i.e. if you need to create new file, create Kotlin file)

Branch naming

Please name your branches in the following syntax: <type>/#<issue-number>_<name>, where

• <type> is either feature or bugfix. Could also be refactor or improvement if it is clearly not a new feature or a bugfix.
• <issue-number> is Github issue number
• <name> is short human-readable name of the feature, spaces replaced with underscores (_).

Example: feature/#100_improve_layout

Building new jsword.jar for And Bible

• See instructions at jsword-tweaks repository