barpec12 / language-files Goto Github PK

Language files for the Shopkeepers plugin. Consider contributing!

BukkitDev Page: https://dev.bukkit.org/projects/shopkeepers
Wiki: https://github.com/Shopkeepers/Shopkeepers-Wiki/wiki
Language Files : https://github.com/Shopkeepers/Language-Files/
Issue Tracker: https://github.com/Shopkeepers/Shopkeepers/issues
Discord Server: https://discord.gg/d9NKd5z
Source code: https://github.com/Shopkeepers/Shopkeepers/

In order to help translators keep track of changes in language files, the language files for different plugin versions are stored in separate branches.

To use one of these language files:

• Select the branch that matches your version of the Shopkeepers plugin:
  Either select the branch in the drop-down menu at the top-left of this page, or click this link for an overview of all branches and then click a branch there to select it.
  Some versions of the Shopkeepers plugin had no changes to their language files, so there is no separate branch for them. In that case, simply pick the next lower version for which this repository contains language files.
• Pick the language file that matches your desired language. If there is no translation for your language yet, consider contributing one!
• Once you have opened a language file, click the [Raw] button in the top right, and then either copy and paste the contents of the language file to a new file on your computer, or use your browser's Save page as... (Ctrl+S) action to download the file.
• In order to then get the Shopkeepers plugin to use your downloaded language file, follow the instructions inside the wiki.

In order to really be of use, this repository depends on contributions for languages other than the defaults. Feel encouraged to add new translations, update outdated translations, or suggest changes to existing translations.

To contribute:

• Fork this repository ([Fork] button in the top-right corner of this page): This creates your own personal copy of this repository.
• Inside your fork, select the branch that matches the plugin version you want to add or edit a language file for.
• Add or edit a language file. This can be done directly here on GitHub. In order to later get your changes accepted, be sure to follow the principles listed below.
• Once you are done with your changes, GitHub shows you an option to commit them: This saves the changes.
• Create a Pull Request: This creates a request to apply the changes from your fork to this base repository.
  • When creating the Pull Request, you might have to click the [compare across forks] button to be able to select your fork repository.
  • GitHub might have created a new branch for your changes. Be sure to select both the correct base branch (the branch inside this base repository you want to apply your changes to), and the correct compare branch (the branch inside your fork repository that contains your changes).
  • GitHub will show you a checkbox somewhere at the bottom whether you want to "Allow edits from maintainers". Consider enabling this option, because this will allow me to do minor edits directly to your changes and speed up the process of adding them to this repository.
  • Click the [Create pull request] button to create the Pull Request.

Alternatively, there are also buttons to add and edit files directly in this repository: When you use those, GitHub will automatically fork this repository for you, create a patch-x branch to store your changes, and afterwards offer you the option to create a Pull Request for your changes.

In order to get your changes accepted, try to follow these principles:

• Stick to the default coloring and formatting scheme of the messages, and of the language file itself.
• Do not include author or server names, advertisements, or links.
• When adding a new language file, follow the naming pattern language-<languageCode>.yml.
• This can be ignored if you add or edit language files directly here on GitHub: Use the UTF-8 encoding for your language file. Some text editors, like for example Notepad++, allow you to easily determine and change the encoding of your language file. Try to use UTF-8 right from the beginning, because changing the file encoding in retrospect might break special characters.
• Prefer creating multiple Pull Requests for independent changes (e.g. when adding or making changes in different language files, or for different plugin versions). On GitHub, you can create multiple "branches", which allows you to keep each of your independent changes separate, and later create individual Pull Requests for them.
  • When you added or edited a file and are about to commit the changes, GitHub offers you an option to create a new branch for these changes.
  • If you add or edit files directly inside this repository, without manually creating a fork first, GitHub will automatically create a fork with a new patch-x branch to store your changes. In this case, you can probably ignore this aspect and let GitHub handle it automatically for you.
• You may also suggest changes or alternatives for already existing translations, including the default translations. But please include an explanation as to why you think that these changes are necessary or useful. If your suggestions affect the default language files, they are either considered for the next version of Shopkeepers, or added as an alternative translation in this repository.
• See the next section for additional notes on updating existing language files for newer plugin versions.

With every update of the Shopkeepers plugin, if there have been changes to the default language files:

• A new branch is created for this plugin version. This branch initially only contains the default language files (english, and likely german since I speak that myself).
• The CHANGELOG is updated: This file roughly summarizes the language file changes of each plugin version.

Follow these steps to update an already existing language file for a new plugin version:

• The old language file inside the branch of the previous version has to stay intact: Do not edit the old language file, but instead create a new language file with the same name inside the branch of the new plugin version.
• Copy the contents of the old language file (from the branch of the previous version) to this new langage file (inside the branch of the new plugin version).
• Go through the list of changes inside the CHANGELOG file and apply them step-by-step to the newly added language file.
  However, the changelog will often times only mention that some messages have changed. In order to figure out what exactly has changed, you will need to compare the contents of the default language file (en-default) of the previous plugin version with the contents of the default language file of the new plugin version. This can be achieved in the following ways:
  • Open the compare page https://github.com/Shopkeepers/Language-Files/compare and select the two branches of the two plugin versions you want to compare. At the bottom of the comparison page, GitHub will then list all files that have changed, and all the lines that have changed within each of these files. Search for the default en-default language file to inspect its changes.
  • Alternative 1: Select the default en-default language file inside the branch of the latest plugin version, and then click the [History] button in the top-right corner of the page. This will bring up the commit history of this file. Select the commit for the latest plugin version update: This will visualize all the lines that have changed compared to the previous version of this file.
  • Alternative 2: Use some external text comparison tool like https://text-compare.com/.

If you have questions or suggestions, join the Discord Server or create an issue.