Skip to content

How to contribute

Timmy Braun edited this page Jun 30, 2022 · 21 revisions

AndBible is an open-source community project. In practice, this means that anyone with suitable skills can, and is encouraged to, contribute to the project.

TL;DR To start a contribution of any kind, open an "Issue" or comment on an existing one, to let us know what you are interested in working on.

Or, if you are a developer with a small-scale change, feel free to just open a PR, stranger. For your own sake, larger changes should probably have an Issue first, so you don't end up spending hours doing something that doesn't get merged 🙃.

Below are specific ways you can contribute, with more information about each.

In addition to this guide, we have a treasure map! Use it to find the location of any precious AndBible resource.

Build the community

  • Help other users who have questions by joining our Telegram, Matrix, or Google discussion group.
  • Promote our Bible Study App whenever you can, especially by giving us a good review on Google Play Store.
  • Advertise: make videos, reviews, blogs...

Report a bug

The best way to report a bug is to use the in-app Bug Report feature, since it automatically provides our developers with some extra data that helps them fix the problem faster. You can also report a bug right here, right now.

Give feedback or request a new feature

Have an idea for a feature? Make a feature request.

Want to test the newest features before they are released (and provide important early feedback)? Join the beta program (scroll to "Get beta versions of apps") at the Google Play Store or by installing the very latest builds. You can then send us your feedback as a bug report or feature request. See our short beta testing introduction for help getting started.

Add modules

Help extend the module library by making new modules or getting licenses for existing ones.

Create media

AndBible always needs new tutorial GIFs/videos, promo images, etc. Ask us what we need (or make a suggestion) by posting a message in the Google Group. If you prefer, you can also contact us at help.andbible@gmail.com.

Translate

Everyone is welcome to help translating AndBible to different languages via easy to use web-based Transifex tool. Check our progress in Transifex. See the translator guide to get started.

Make a how-to guide for a feature

If you want to create or update a guide, please open a request with your wording or media, or just ask for feedback on your idea before you start. You can help AndBible users by making a guide to appear in the app, website, or both!

(And if you're a developer, you can head straight to the readthedocs project and make a fork + PR)

Develop for AndBible

Do you know Android development, Kotlin, Javascript and/or Vue.js? These are the main technologies used in the project. If you are a developer, your skills might be of great use in this project. Pull requests are welcome! See developer documentation for a setup walkthrough and simple steps to make your first PR.

Go ahead and browse some easy first Issues⚡. If you see one that doesn't have enough detail for you to get started, please ask us for a head start. Asking for detail helps us. This is good. You are not a nuisance noob. You are loved.

Add to developer docs

We use GitHub Wiki for our developer documentation, so if you want to suggest an edit, make a new Issue with your suggestion.

Discuss something else that doesn't fit in these categories

If you have something more obscure to discuss, there's an Issue template for that too. Or, you may be looking for ways to chat in the Discover section of the AndBible Website.

Clone this wiki locally