magento / magento/community-features

CI: Validate i18n coverage

Open
#244 6 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Priority: P3
Dominant language
No language data
Stars
46
Forks
14
PR merge metrics
No merged PRs in 30d

Description

Summary (*)

Currently when new PR introduces new Phrase to be translated, it's very uncommon to remember about adding the phrase to i18n/en_US.csv.

Examples (*)
  • https://github.com/magento/magento2/pull/26440 Even without creating new phrase, the old phrase is not covered in i18n file. What is more - even if there were such entry in CSV, contributor's change would lead to introduce new not-covered string.
Proposed solution

This would be useful to have Static Analysis Tool that verifies if Contributor haven't introduced new phrase that was not covered in i18n, and after some time - require to have all phrases from modified files in proper i18n.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by examining the existing i18n/en_US.csv coverage and the modified files that introduce translatable phrases. Review the linked example PR to understand uncovered strings and determine how static analysis should detect them. Done means the validation identifies new uncovered phrases and defines when all phrases in modified files must be present in the i18n file.

Written by the indexing model from the issue text.

Assessment

Domain
internationalization, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.