Skip to content

chore: update i18n contributing guide#1030

Merged
danielroe merged 7 commits intonpmx-dev:mainfrom
userquin:chore-update-contributing-guide
Feb 5, 2026
Merged

chore: update i18n contributing guide#1030
danielroe merged 7 commits intonpmx-dev:mainfrom
userquin:chore-update-contributing-guide

Conversation

@userquin
Copy link
Contributor

@userquin userquin commented Feb 5, 2026

This PR includes the following changes to CONTRIBUTING.md file:

  • add link to unicode.org plural rules spec
  • use underscore instead dash for translation keys
  • don't concatenate strings in vue templates: link to vue-i18n component and some examples
  • fix some typos (coderabbitai)

@vercel
Copy link

vercel bot commented Feb 5, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
npmx.dev Error Error Feb 5, 2026 6:06pm
2 Skipped Deployments
Project Deployment Actions Updated (UTC)
docs.npmx.dev Ignored Ignored Preview Feb 5, 2026 6:06pm
npmx-lunaria Ignored Ignored Feb 5, 2026 6:06pm

Request Review

@codecov
Copy link

codecov bot commented Feb 5, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 5, 2026

📝 Walkthrough

Walkthrough

The CONTRIBUTING.md was updated to expand localisation guidance. The "Adding a new locale" step now references both a Pluralization rule callback and a separate Plural Rules resource. Guidance was added under "Update translation" and "Adding translations" explaining placeholder usage, advising against string concatenation in templates, recommending the i18n-t utility for complex content, and providing bad/good examples and a complex-content scenario. Translation key conventions were changed to prohibit dashes and require underscores (for example privacy_policy instead of privacy-policy).

Suggested reviewers

  • danielroe
  • whitep4nth3r
🚥 Pre-merge checks | ✅ 1
✅ Passed checks (1 passed)
Check name Status Explanation
Description check ✅ Passed The pull request description accurately relates to the changeset, detailing all main modifications to CONTRIBUTING.md including pluralization rules, translation key conventions, vue-i18n guidance, and typo fixes.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
CONTRIBUTING.md (1)

348-348: ⚠️ Potential issue | 🟡 Minor

Fix typo: “then English” → “the English”.
Minor grammar issue in the sentence about outdated translations.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
CONTRIBUTING.md (1)

427-442: Consider clarifying the complex content example.

The i18n-t example references translation keys (terms_link and privacy_policy) that aren't shown in the JSON snippet on line 430. Contributors might find it clearer if the example included the complete JSON structure.

📖 Suggested enhancement for clarity
+   **Example JSON:**
+
    ```json
-   { "agreement": "I accept the {terms} and {privacy}." }
+   {
+     "agreement": "I accept the {terms} and {privacy}.",
+     "terms_link": "Terms of Service",
+     "privacy_policy": "Privacy Policy"
+   }
    ```

+   **Example Vue template:**
+
    ```vue
    <i18n-t keypath="agreement" tag="p">
      <template `#terms`>
        <NuxtLink to="/terms">{{ $t('terms_link') }}</NuxtLink>
      </template>
      <template `#privacy`>
        <strong>{{ $t('privacy_policy') }}</strong>
      </template>
    </i18n-t>
    ```

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

@danielroe danielroe added this pull request to the merge queue Feb 5, 2026
Merged via the queue into npmx-dev:main with commit 76b1fa3 Feb 5, 2026
16 of 17 checks passed
@userquin userquin deleted the chore-update-contributing-guide branch February 5, 2026 18:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants