3. How to help with translations

How to help with translations

First of all, thanks. That means a lot.

If you are planning to update existing translations, you can check out automated progress reports and details about missing strings that need yet to be translated: /meta/translations.md

0. Register here if you still don't have an account - that's mandatory.

1. Create a fork of my project; there's a button up there.

2. You will get yourself a copy that belongs to you.

3. You can do it multiple ways, but the best way to do updates if you are not familiar with Version Control Systems is via GitHub Desktop. Let's assume that you've downloaded and logged into the application.

4. Choose the repository with the fork icon and confirm where on your hard drive you would like to clone it.

5. Set "To contribute to the parent project." This one doesn't really do anything unless you plan to make something else from translation help.

6. Head to where you have cloned your fork and then go down to the GalaxyBudsClient\i18n\. This is where all the language files are stored.

7. Copy one that's called en.xaml into the configuration directory. That should be something like C:\Users\USERNAME\AppData\Local\GalaxyBudsClient. You can access this directory by pressing Windows+R on your keyboard and entering %LOCALAPPDATA%\GalaxyBudsClient\ into the run box. (On Linux, you can use this directory: ~/.config/GalaxyBudsClient/)

8. After you've got a copy there, rename it into custom_language.xaml and restart the application. You now will get access to translator mode, which will allow you to swap between application screens and ignore connection loss. That's it. Now, you can translate, save the file, and use the reload button to see how changes are looking because they may not fit in.

9. Now, you need to register your translation in the source code; you don't need any programming knowledge for this. Go to GalaxyBudsClient\Model\Constants.cs and find the section public enum Locales in that file. You should see a list of all available languages known to the app.

10. Insert your language into the enumeration in this format:

   [Description("German")]
   de,

First, insert the language's name in English into the description meta-attribute and replace the second line with your language's country code. If you are not sure what to do, you can also skip this step, and I'll add it for you.

You must not place this new entry above the English or below the custom_language.xaml entry.

11. When you've finished doing that stuff and are sure that everything looks fine, you can return to the GitHub Desktop to save (commit) your changes.

12. Use the left bottom panel to specify what you've done. For example, you can write something like "Added a new language." An additional message is optional but not required.

13. Commit to master. After receiving a blue pop-up about "Push commits to the origin remote" - confirm it. Your changes to your fork are now cloud-synced.

14. Now, get back to the web version of GitHub to open pull requests and propose your changes. Open the main page of your fork.

15. Approximately in the middle, you will see a message that looks like "This branch is N commits ahead of timschneeb:master." There is also a Pull Request button to the right.

16. Use the button, fill in all the details about what you've done, include a message if you'd like a little chat, and send for approval.