Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Allow users to contribute translations with POEditor #2894

Merged
merged 7 commits into from
May 13, 2024

Conversation

t1m0thyj
Copy link
Member

@t1m0thyj t1m0thyj commented May 1, 2024

Proposed changes

Created a POEditor project where users can contribute translations. Added two dev scripts:

  • scripts/generatePoeditorJson.js - Generates l10n json file in a format that can be imported into POEditor
  • scripts/downloadPoeditorL10n.js - Downloads user-contributed translations in a format that can be bundled in VSIX

To maintain these translations going forward:

  • Every time we enter code freeze we should follow step 5 added to the wiki article Preparing for release to upload any new l10n terms that have been added.
  • To include user-contributed translations there is nothing we need to do 🙂 The deployment workflow will automatically download and bundle them in future v3 releases.

This PR also cleans up some redundant localization strings and fixes an issue where the string "Favorites" was not always being localized which could cause ZE activation to fail.

TODO:

  • Test adding contributors to POEditor project
  • Test translation with format strings like {0} and {1}
  • Update wiki to mention POEditor upload at code freeze
  • Update readme to encourage contributing translations

Release Notes

Milestone: v3

Changelog: N/A

Types of changes

What types of changes does your code introduce to Zowe Explorer?
Put an x in the boxes that apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Updates to Documentation or Tests (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This checklist will be used as reference for both the contributor and the reviewer

  • I have read the CONTRIBUTOR GUIDANCE wiki
  • PR title follows Conventional Commits Guidelines
  • PR Description is included
  • gif or screenshot is included if visual changes are made
  • yarn workspace vscode-extension-for-zowe vscode:prepublish has been executed
  • All checks have passed (DCO, Jenkins and Code Coverage)
  • I have added unit test and it is passing
  • I have added integration test and it is passing
  • There is coverage for the code that I have added
  • I have tested it manually and there are no regressions found
  • I have added necessary documentation (if appropriate)
  • Any PR dependencies have been merged and published (if appropriate)

Further comments

Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com>
@t1m0thyj t1m0thyj linked an issue May 1, 2024 that may be closed by this pull request
Copy link

codecov bot commented May 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.40%. Comparing base (50f57ee) to head (28757bf).

Additional details and impacted files
@@           Coverage Diff           @@
##             next    #2894   +/-   ##
=======================================
  Coverage   93.40%   93.40%           
=======================================
  Files         121      121           
  Lines       10834    10835    +1     
  Branches     2280     2232   -48     
=======================================
+ Hits        10119    10120    +1     
  Misses        713      713           
  Partials        2        2           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com>
@zFernand0 zFernand0 self-requested a review May 2, 2024 14:42
@zFernand0
Copy link
Member

😻Love this enhancement😻

@t1m0thyj t1m0thyj changed the title WIP Allow users to contribute translations with POEditor Allow users to contribute translations with POEditor May 9, 2024
@t1m0thyj t1m0thyj added this to the v3 pre-releases milestone May 9, 2024
t1m0thyj added 3 commits May 9, 2024 10:43
Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com>
Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com>
@t1m0thyj t1m0thyj marked this pull request as ready for review May 9, 2024 18:58
Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com>
@t1m0thyj t1m0thyj force-pushed the feat/poeditor-l10n branch from e9d0e2d to 3758d32 Compare May 9, 2024 19:01
@t1m0thyj t1m0thyj requested a review from anaxceron May 9, 2024 19:01
Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com>
Copy link

sonarqubecloud bot commented May 9, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

Copy link
Contributor

@anaxceron anaxceron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nicely done -- thank you @t1m0thyj

Copy link
Member

@traeok traeok left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your work on this @t1m0thyj, this will make it a lot easier to contribute ZE translations moving forward 😋
LGTM - tested on Windows and the script works as expected

Copy link
Member

@zFernand0 zFernand0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes LGTM! 😋
I do have one small change that might need to be addressed😋

@JillieBeanSim JillieBeanSim merged commit 714b23c into next May 13, 2024
18 checks passed
@JillieBeanSim JillieBeanSim deleted the feat/poeditor-l10n branch May 13, 2024 13:03
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Move from Zanata to POEditor
5 participants