phetsims / phetsims/chipper

Write a script that checks if any published sim uses a common code string key that doesn't exist on main

Open
#1,407 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
17
Forks
20
PR merge metrics
No merged PRs in 30d

Description

It has always been challenging to realize that an update to a string file on master has ramifications for translation of a release branch. I recommend a script to detect these, and perhaps a metadata flag to mark them as such (so that it is easy to realize when a string key applies).

If the stringKey is called vestigialForReleasedTranslation (very clear), then we could also double check that this key is only used on keys that are in fact used in release branches (to help us get rid of those strings if in fact they aren't used anywhere.

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 locating how published simulations, main-branch string keys, and release-branch translations are represented in the repository. Define the checks for common keys missing on main and for the proposed vestigialForReleasedTranslation marker. Done means the script reliably reports these cases and verifies marked keys against release-branch usage.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
localization, 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.