[skip changelog] Add readme for localization data #1837
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Arduino CLI has been translated to 12 languages. The localization process follows the following steps: 1. An English language source string is defined in the Arduino CLI codebase 2. The source string is pushed to Transifex 3. Community translators localize the string 4. The localization data is pulled into the Arduino CLI repository 5. The localization data is incorporated into the Arduino CLI distribution Experience with maintenance of the Arduino IDE 1.x project indicates that the data files generated at step (4) can appear to be the appropriate place to make edits for casual contributors not familiar with the project's sophisticated internationalization infrastructure. Since those files are generated by automated systems, any edits made there would only be overwritten, so it is important to clearly communicate the correct way to make enhancements or corrections to these strings. This is accomplished by a local readme file most likely to be seen by those working in the folder containing these files, which supplements the existing information about translation in the project's CONTRIBUTING.md.
per1234
added
type: enhancement
cmaglie
pushed a commit
to cmaglie/arduino-cli
that referenced
this pull request
Aug 22, 2022
Arduino CLI has been translated to 12 languages. The localization process follows the following steps: 1. An English language source string is defined in the Arduino CLI codebase 2. The source string is pushed to Transifex 3. Community translators localize the string 4. The localization data is pulled into the Arduino CLI repository 5. The localization data is incorporated into the Arduino CLI distribution Experience with maintenance of the Arduino IDE 1.x project indicates that the data files generated at step (4) can appear to be the appropriate place to make edits for casual contributors not familiar with the project's sophisticated internationalization infrastructure. Since those files are generated by automated systems, any edits made there would only be overwritten, so it is important to clearly communicate the correct way to make enhancements or corrections to these strings. This is accomplished by a local readme file most likely to be seen by those working in the folder containing these files, which supplements the existing information about translation in the project's CONTRIBUTING.md.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please check if the PR fulfills these requirements
before creating one)
our contributing guidelines
UPGRADING.mdhas been updated with a migration guide (for breaking changes)What kind of change does this PR introduce?
Documentation enhancement
What is the current behavior?
Arduino CLI has been translated to 12 languages.
The localization process follows the following steps:
Experience with maintenance of the Arduino IDE 1.x project indicates that the data files generated at step (4) can appear to be the appropriate place to make edits for casual contributors not familiar with the project's sophisticated internationalization infrastructure.
Since those files are generated by automated systems, any edits made there would only be overwritten. If a contributor targeting localized data starts from
CONTRIBUTING.md, they will be directed to the appropriate place to do that on Transifex. However, they may not use that entry point to their efforts, or they may be targeting the English language source strings instead.What is the new behavior?
A readme file located in the same folder as the localization data explains the correct ways to contribute to that content, supplementing the existing information in
CONTRIBUTING.md.Does this PR introduce a breaking change, and is titled accordingly?
No breaking change.
Other information
The rendered content can be previewed here:
https://github.com/per1234/arduino-cli/tree/l10n-data-docs/i18n/data#readme