tenacityteam/tenacity-legacy

RFC: Renaming localisations

Open

#145 opened on Jul 8, 2021

View on GitHub
 (8 comments) (0 reactions) (1 assignee)C++ (275 forks)batch import
help wanted

Repository metrics

Stars
 (6,921 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

It looks like the way English localisations are handled right now is by using the key if no localisation file is found. There is no en file, only a file for each other language.

The code calls a method like this, with the English language as the key:

https://github.com/tenacityteam/tenacity/blob/faa23d1b2bc4c7bc62c64922a3b7f891756b796d/src/menus/HelpMenus.cpp#L561-L563

Then, that English text is referenced as a key in a localisation file.

https://github.com/tenacityteam/tenacity/blob/faa23d1b2bc4c7bc62c64922a3b7f891756b796d/locale/fr.po#L1186-L1188

Changing the key does change the text in my tests: image

So, I think for renaming we have a few options:

  1. Rename all these keys

Merging in changes from upstream could be a lot harder due to all the changes.

  1. Add an en localisation file

This would require us to make sure to add to this file when new keys get added. (My preferred solution)

  1. Adjust the XO() macro to replace the name Audacity with Tenacity

Kind of a sketchy option, but might be the safest for merging in changes from upstream.

What do you guys think? Any other ideas?

Contributor guide

Research direction
Study the current localization mechanism in Tenacity, understand how keys are used and how translations are loaded, then evaluate the three proposed options (renaming all keys, adding an en file, or modifying the XO() macro) and any other alternatives, considering maintainability and upstream merge impact.
Tech stack
cpp
Domain
internationalization
Issue type
Research
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++GitGettext
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70