Skip to content

feat: enhance translation script (i18n) with custom translations#663

Closed
RawanMatar89 wants to merge 1 commit into
openedx:developfrom
zeit-labs:custom-translations
Closed

feat: enhance translation script (i18n) with custom translations#663
RawanMatar89 wants to merge 1 commit into
openedx:developfrom
zeit-labs:custom-translations

Conversation

@RawanMatar89

Copy link
Copy Markdown
Contributor

Summary:
The localization script has been updated to scan for a specific file named CustomLocalizable.strings within the .lproj directories of the app modules.

Merging Strategy:

  • The script reads the base Localizable.strings (the default Open edX translations).
  • It then loads the CustomLocalizable.strings file if it exists.
  • The script includes a safety check to skip directories that do not contain a .xcodeproj file, preventing execution in non-module folders.
  • For the source language (en.lproj), the logic ensures that the original source files are updated if needed.
  • Added clear header comments in the output files to distinguish between community translations and custom overrides.

Priority Logic: Keys defined in CustomLocalizable.strings take precedence. If a key exists in both files, the custom value overwrites the default value in the final output.

Changes:

Screenshots:

Description Image
add CustomLocalizable.strings file to any module Screenshot 2026-05-21 at 08 39 26
The content of the CustomLocalizable.strings file Screenshot 2026-05-21 at 08 41 12
The result of executing 'make pull_translation' Screenshot 2026-05-21 at 08 42 18
Shows that the overwritten key exists only once in the final translations file Screenshot 2026-05-21 at 08 43 00

why?
It keeps custom changes separate from core changes, making it easier to pull upstream updates from Open edX without merge conflicts in .strings files.

Testing:
Verified that the script completes successfully even if a module has no CustomLocalizable.strings file.
Verified the --split and --combine commands.

Jira link:
https://zeitlabs.atlassian.net/browse/CC-18

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Jun 22, 2026
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @RawanMatar89!

This repository is currently maintained by @openedx/openedx-mobile-maintainers.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Jun 22, 2026
@github-project-automation github-project-automation Bot moved this from Needs Triage to Done in Contributions Jun 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants