chore: translation docs

[hiheyhello123]

Summary by CodeRabbit

• Documentation
  • Enhanced contribution guidelines to include a dedicated internationalization section.
  • Provided detailed steps and quality checks for adding translations, ensuring consistent formatting and clarity.
  • These improvements support robust multi-language features, enhancing the overall accessibility and user experience globally.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
0	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 14, 2025 9:36pm

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request updates the .github/CONTRIBUTING.md file by adding a new "Internationalization (i18n)" section. The section provides guidelines for contributors on adding translations for new features. It specifies adding English source strings to a JSON file, following i18n formatting standards including variable usage and pluralization rules, and ensuring quality through an externalized UI text checklist. The updated document also includes a reference to the detailed translation process in TRANSLATION.md and an updated Table of Contents.

Changes

File	Summary
.github/CONTRIBUTING.md	Added a new "Internationalization (i18n)" section with subsections on adding translations for new features, formatting standards, and a quality checklist.

Possibly related PRs

• docs #438: This PR is related as it introduces translation process guidelines in TRANSLATION.md, complementing the new internationalization guidelines in this document.

Suggested reviewers

• zerodotemail

Poem

Hop, hop, hop—I'm the coding bunny,
Adding i18n rules to make our work sunny!
English strings and checks in a line,
Making translations simple and fine.
With every guideline, our project takes flight! 🐇

Cheers to change, oh what a delight!

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b143559 and 5bee8af.

📒 Files selected for processing (1)

• .github/CONTRIBUTING.md (2 hunks)

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.