Provide a guideline for how to deal with check-translations check

[scnwwu]

Several recent PRs got check-translations check fail. But we don't have documentation for how to solve it. Some authors updated message files and left the new messages un-translated, some made them with Google Translate, some reached to previous contributors for translations.
Shall we provide a guideline for it?

My 2 cents is that we can say it would be fine to just run update-locale and leave new messages un-translated. It would be easier to all contributors. Of course they can translate the language they know.

cc @scottdover

[scnjdl]

The CONTRIBUTING.md is not exact to the real situation. Only "updating a current locale" is not enough because build check for a PR will compare all resource files, not only your cared. It will always result in a fail.

[scottdover]

yeah, I've noticed there is some confusion with the github action. I wonder if a documentation update would help.

In my opinion, people shouldn't be adding translations to their PRs unless they are also native speakers of whatever language they are adding translations for. This means check-translations will fail. However, check-translations is not required for merging code (only build is required).

If they add new messages, untranslated, they could get lost when things need to be translated (or at the very least, make it harder for a translator to make sure they catch all the strings).

check-translations is really only there to bring awareness to the fact that we need to add translations at some future point.

With all that in mind, my preference is to let the checks fail, and perhaps before we release new versions we start a PR just for translating the new strings. Thoughts @scnwwu ?

[scnwwu]

Then it looks NOT intuitive to me to run this check for each PR (and seeing a lot of failure is not a happy experience😄).

How about trigger this check on push event to main branch?

Another thing is that it would be great if the check can output the locale(s) that need translation. As normally one contributor just contribute to one language, it would be more easier to tell what language needs attention.

[scottdover]

and seeing a lot of failure is not a happy experience😄

Yes! I worried about this, too.

How about trigger this check on push event to main branch?

This is a great idea! I'll circle back today and look into this.

[scottdover]

How's this? #495

[scottdover]

Closing this as we have a somewhat better solution, now :)