Contributing translations

Reactive Resume is used all over the world. If you speak a language other than English, you can help by contributing translations.

How translations work

Reactive Resume uses Crowdin as its localization management platform. Crowdin gives translators an interface for contributing translations without writing code or editing files directly.

Once translations are submitted and approved on Crowdin, they are automatically synced to the codebase and will be available in the next release of the app.

Updating catalogs in a checkout

The PDF renderer uses a generated subset of the same translations for default section headings. Run pnpm pdf:translations after editing or syncing the PO catalogs. The root pnpm lingui:extract, pnpm check, and pnpm build commands also regenerate this file automatically.

Commit packages/pdf/src/section-title-catalog.json with the catalog updates. Edit the source PO files rather than the generated JSON; a tooling test checks that they stay synchronized.

Getting started

<Step title="Join the Reactive Resume Project">
	Navigate to the [Reactive Resume project on Crowdin](https://crowdin.com/project/reactive-resume) and click **Join**
	to become a contributor.
</Step>

<Step title="Select Your Language">
	From the project dashboard, click on the language you want to translate. You'll see a list of files that need
	translation along with the progress for each.
</Step>

<Step title="Start Translating">
	Click on a file to open the Crowdin Editor. You'll see the source text (English) on the left and a text field for
	your translation on the right. - Translate the text accurately while preserving any placeholders or formatting - Use
	the suggestions from Translation Memory and Machine Translation as a starting point - Vote on existing translations
	if you agree with them
</Step>

<Step title="Save Your Translations">
	Your translations are saved automatically as you work. Once reviewed, they'll be included in the next app release.
</Step>

Translation guidelines

To maintain consistency across all translations, please follow these guidelines:

Preserve placeholders

Some strings contain placeholders like {name} or {count}. These must remain unchanged in your translation:

English: "Hello, {name}!"
Spanish: "¡Hola, {name}!"

Keep formatting

Preserve any HTML tags or markdown formatting in the source text:

English: "Click <1>here</1> to continue"
German: "Klicken Sie <1>hier</1>, um fortzufahren"

Use formal or informal tone consistently

Choose either formal or informal language based on what's standard for software in your language, and stick with it throughout.

Technical terms

Some technical terms (like "PDF", "URL", "JSON") are often kept in English across languages. Use your judgment based on what's common in your language's software community.

Requesting a new language

If your language is not listed in the Crowdin project, you can request it to be added.

To request a new language:

1. Go to the GitHub Issues page
2. Click New Issue
3. Select the appropriate template or create a blank issue
4. Title it something like: "Add [Language Name] to Reactive Resume"
5. Include the language name and locale code (e.g., "Japanese - ja-JP") in the issue description.

Once approved, the language will be added to Crowdin and you can begin translating.

When will my translations appear?

Translations submitted on Crowdin are synced to the codebase periodically. Once merged, they will be included in the next release of Reactive Resume.

Tips for effective translation

Need help?

Thank you for helping translate Reactive Resume.