Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add context comments to i18n key #3988

Merged
merged 1 commit into from
Apr 1, 2024
Merged

Add context comments to i18n key #3988

merged 1 commit into from
Apr 1, 2024

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Mar 29, 2024

Fixes

Fixes #617 by @obulat

Description

This PR adds comments to the i18n strings that are used inside a full sentence:

{
  /**
  Interpolated into hero.disclaimer.content:
   _{license}_ part of "All Openverse content is under a _{license}_ or is in the public domain."
  */
  license: "Creative Commons license",
}

This allows the translators to correctly select the word forms that match the full sentence.

It would be great if we could automate the creation of such comments, but I didn't find an easy way of doing that.
Still, having such comments is very important for accurate translations.

Testing Instructions

Run the app locally using just frontend/run dev
You should not see any warnings about i18n keys missing in the console on any page of the site.

Also, look through the strings and see check that the comments look correct.

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@obulat obulat requested a review from a team as a code owner March 29, 2024 18:32
@obulat obulat requested review from zackkrida and dhruvkb March 29, 2024 18:32
@openverse-bot openverse-bot added 🟧 priority: high Stalls work on the project or its dependents ✨ goal: improvement Improvement to an existing user-facing feature 💻 aspect: code Concerns the software code in the repository 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Mar 29, 2024
@github-actions github-actions bot added the 🧱 stack: frontend Related to the Nuxt frontend label Mar 29, 2024
@obulat obulat removed the 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work label Mar 29, 2024
Copy link
Member

@zackkrida zackkrida left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is very thoughtful. It looks like you removed some unused strings too? LGTM.

@dhruvkb
Copy link
Member

dhruvkb commented Apr 1, 2024

The primary reason for switching to JSON5 was to provide such helpful context to the translators! Thanks for utilising it.

@obulat
Copy link
Contributor Author

obulat commented Apr 1, 2024

This is very thoughtful. It looks like you removed some unused strings too? LGTM.

Yes, I did remove unused strings and renamed a string in the comments (updated from kebab-case to camelCase). Forgot to add this in the PR descriptions.

@obulat obulat merged commit 87a290b into main Apr 1, 2024
72 checks passed
@obulat obulat deleted the add/i18n-context branch April 1, 2024 05:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository ✨ goal: improvement Improvement to an existing user-facing feature 🟧 priority: high Stalls work on the project or its dependents 🧱 stack: frontend Related to the Nuxt frontend
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Translation strings partials should be linked with the whole sentence.
4 participants