Skip to content

Latest commit

 

History

History
54 lines (41 loc) · 3.75 KB

CONTRIBUTING.md

File metadata and controls

54 lines (41 loc) · 3.75 KB
Raw

Contributing to the QuranApp

Thank you for considering contributing to the QuranApp! May Allah reward you for any useful contribution. We welcome and appreciate any contributions, it can be:

  • Quran Translations
  • App Translations
  • Recitations
  • Bug reports
  • Feature requests
  • Code contributions
  • Documentation improvements
  • Design suggestions

We welcome your contribution to even this page. Also, we have aggregated some ideas for the app in roadmap which you may start working on.

Before you start

Please note that all new code contributions must be written in Kotlin. Only critical patches can be done in Java. Please follow the Kotlin Coding Conventions and the Android Kotlin Style Guide. You may also setup our kotlin_code_style.xml in your IDE.

Getting Started

  1. Fork the repository and clone it to your local machine.
  2. Make sure you have the necessary tools and dependencies to build the project, including Android Studio and the Android SDK.
  3. Open the project in Android Studio and make your changes.
  4. Create a new branch for your changes.
  5. Commit your changes with a clear and descriptive commit message.
  6. Push your changes to your fork and submit a pull request with a proper explanation.

Quran Translations

The quran translations used in the app are in a special format. If you would like to contribute a translation, you can find the format in one of the translations in the inventory. You must consider the following points:

  1. The translation must be in JSON format and illegal characters like quotes, backslashes, etc. must be escaped.
  2. Every footnote reference must be enclosed in html syntax or it will not be parsed correctly. The syntax is <fn id="[id]" index="[index]">[display_text]</fn>. Explanation:
    • [id] is the id of the footnote. It is unique to the whole translation file.
    • [index] is the one-based index of the footnote in the specific verse. It is unique to the verse.
    • Example: <fn id="9" index="1">1</fn>. This means that the footnote with id 9 is the first footnote in the verse.
  3. Every verse reference must be enclosed in html syntax or it will not be parsed correctly. The verse references have several syntax which are:

    • <reference chapter="[chapter_no]" verses="[verse_no]">[display_text]</reference>.

      Example: <reference chapter="1" verses="1">1:1</reference>. This means that the reference is to chapter 1, verse 1.

    • <reference chapter="[chapter_no]" verses="[from_verse_no]-[to_verse_no]">[display_text]</reference>.

      Example: <reference chapter="1" verses="1-5">1:1-5</reference>. This means that the reference is to chapter 1, verses from 1 to 5.

    • <reference chapter="[chapter_no]" verses="[verse_1],[verse_2],[verse_n]">[display_text]</reference>.

      Example: <reference chapter="2" verses="1,5,29">2:1,5,29</reference>. This means that the reference is to chapter 1, verses 1, 5, and 29.

Recitations

You can provide free api links to recitations similar to available_recitations_info.json.

App Translations

If you would like to translate the app in your language, you may do so by visiting this link. You can add a new language or contribute to the existing languages. The following chart shows the current status of app language translations.

Translation status