gaspersic/freeCodeCamp
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

fix(docs): additional i18n notes (#41084)

Browse Source 
* fix(docs): note about PR language

Adds a note that PR title, body, commits, and code should all be
in English.

* feat(docs): additional notes

Adds note about setting Crowdin to show HTML tags instead of number
tags, and note about what to do when overriding a QA check.

* fix: apply review suggestions

Co-authored-by: Oliver Eyton-Williams <ojeytonwilliams@gmail.com>

Co-authored-by: Oliver Eyton-Williams <ojeytonwilliams@gmail.com>
This commit is contained in:
Nicholas Carrigan (he/him) 2021-02-12 10:54:24 -08:00 committed by GitHub
parent 36d374fb4e
commit b2526c855a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/how-to-open-a-pull-request.md
View File

@ -2,6 +2,9 @@
A pull request (PR) enables you to send changes from your fork on GitHub to freeCodeCamp.org's main repository. Once you are done making changes to the code, you can follow these guidelines to open a PR.
> [!NOTE]
> Your PR should be in English. See [here](#index.md?id=translations) for how to contribute translations.
## Prepare a good PR title
We recommend using [conventional title and messages](https://www.conventionalcommits.org/) for commits and pull request. The convention has the following format:

11
docs/how-to-translate-files.md
View File

@ -21,6 +21,9 @@ Each file and folder will show a progress bar. The **blue** portion of the progr
Select a file to work on and Crowdin will open the editor view.
> [!NOTE]
> When the editor view opens, you will need to click the settings icon (shown as a gear) and switch the 'HTML tags displaying' setting to 'SHOW'. This will ensure you can see tags such as `<code></code>` instead of `<0></0>`.
## Translate the File
![Image - Editor View](./images/crowdin/editor.png)
@ -74,13 +77,7 @@ When you attempt to save a translation, you may see a warning message appear wit
This message appears when Crowdin's QA system has identified a potential error in the proposed translation. In this example, we have modified the text of a `<code>` tag and Crowdin has caught that.
> [!WARNING]
> You have the option to save a translation in spite of errors, but this should be done only in circumstances where the error might be incorrect.
Crowdin will sometimes convert HTML tags (such as `<code>`) into numerical values, like `<0>text</0>` or `<1>text</1>`. These tags are usually code tags, and our QA check will verify that these have not been translated. However, sometimes these may be `<strong>` or `<em>` tags, which _should_ be translated. If you hover over a numerical tag in the source string, you can see which HTML tag or tags have been replaced:
![Image - Hover over a tag](./images/crowdin/tag-hover.png)
If the replaced tags are something that should be translated (such as `strong` tags), translate the content within the tags and select "Save Anyway" when the error appears. Then leave a comment on the string explaining that the tags are `strong` (for example) so other translators and proofreaders are aware that they should be translated.
> You have the option to save a translation in spite of errors. If you do, by clicking "Save Anyway", you should also tag a proofreader or project manager and explain why the QA message needs to be ignored in this case.
## Translation Best Practices