Skip to content

Latest commit

 

History

History
39 lines (22 loc) · 2.44 KB

CONTRIBUTING.md

File metadata and controls

39 lines (22 loc) · 2.44 KB
Raw

Contributing Guidelines

Before you start contributing, make sure you already understand how Git works. You can learn it from the GitHub documentation.

🌍 Translation Guide

  1. First you need to determine the locale of the target language you are going to translate into.

    A locale for a language looks like this: en, zh, ja, etc. If a language is somewhat different in some regions and you need to translate it differently, then its locale looks like this: en_US, zh_CN, zh_TW, etc.

    You can check all supported locales by launching AirPodsDesktop from the terminal with argument --print-all-locales, or --print-all-locales=Complete to check all full locale names (with regions).

    Examples:

    cd path/to/AirPodsDesktop
./AirPodsDesktop --print-all-locales
./AirPodsDesktop --print-all-locales=Complete

  2. You will need the Qt Linguist tool to complete the translation work. If you didn't have it, please download and install Qt 5.15.2.

  3. This step is to get the .ts translation file for a new target locale. If you just want to improve an existing translation, you can skip this step.

    You can open an issue to request a .ts translation file directly. Or continue with this step to get the .ts translation file yourself (requires you to build AirPodsDesktop yourself).

    1. Follow the Build Instructions to complete the first build.

    2. Adds the target locale to the variable APD_TRANSLATION_LOCALES in CMakeLists.txt.

    3. Rebuild AirPodsDesktop once and you will see the .ts translation file for your target locale in directory /Source/Resource/Translation.

  4. Open the .ts translation file with Qt Linguist tool and complete the translation.

    If you don't know how to use the tool, please read Qt Linguist Manual: Translators.

  5. If you search for comments containing "credit" in Qt Linguist, you will see a text for crediting translators. If you wish, you can add your name to its translation as required by the developer comment.

  6. After completing the translation work, submit a PR for merging.