Skip to content

Comments

docs#438

Merged
hiheyhello123 merged 6 commits intostagingfrom
crowdin
Mar 14, 2025
Merged

docs#438
hiheyhello123 merged 6 commits intostagingfrom
crowdin

Conversation

@hiheyhello123
Copy link
Contributor

@hiheyhello123 hiheyhello123 commented Mar 14, 2025

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive translation guide to assist community contributors with localizing the application.
    • Updated the main documentation to include a reference to this translation guide, encouraging community involvement in translation efforts.

@vercel
Copy link

vercel bot commented Mar 14, 2025

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 3:39am

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 14, 2025

Walkthrough

The pull request introduces a new translation guide in the form of a file, .github/TRANSLATION.md, which provides detailed instructions and guidelines for translating the 0.email application. Additionally, the README.md file is updated to include a reference to this new translation guide in the contributing section. Both changes aim to streamline the translation process and enhance community contributions without modifying any application logic.

Changes

File Change Summary
.github/TRANSLATION.md Added a comprehensive translation guide outlining the process for contributing translations, preserving format tags and variables, and testing translations.
README.md Inserted a new line in the contributing section, inviting users to assist with translating the application via a link to the translation guide.

Possibly related PRs

  • i18n #437: Implements translation functionality and adds new locales, which connects to the translation guide introduced in this pull request.

Suggested reviewers

  • MrgSub

Poem

I'm a rabbit with whiskers so keen,
Hopping through docs in a code routine.
New guides for tongues begin to bloom,
Translating Zero, banishing gloom.
Happy hops and carrots in flow,
Celebrating changes with a joyful glow!

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.

🪧 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.

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: 0

🧹 Nitpick comments (3)
.github/TRANSLATION.md (3)

15-15: Punctuation Improvement Needed

The sentence on line 15 is missing a comma after "listed" for better readability.

-If the language you'd like to help with isn't listed you can open an issue and mention [@needleXO](https://github.com/needleXO)
+If the language you'd like to help with isn't listed, you can open an issue and mention [@needleXO](https://github.com/needleXO)
🧰 Tools
🪛 LanguageTool

[uncategorized] ~15-~15: A comma might be missing here.
Context: ... language you'd like to help with isn't listed you can open an issue and mention [@nee...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)


19-19: Sentence Restructuring Suggestion

The sentence on line 19 can be made clearer by splitting it into two sentences. This improves readability and ensures the guidance is immediately understandable.

-We will go through the process as soon as possible, once you have been accepted you should get a Direct Message from `@zerodotemail` on Discord
+We will go through the process as soon as possible. Once you have been accepted, you should get a Direct Message from `@zerodotemail` on Discord
🧰 Tools
🪛 LanguageTool

[uncategorized] ~19-~19: A comma might be missing here.
Context: ...as soon as possible, once you have been accepted you should get a Direct Message from `@...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)


59-59: Insert Missing Comma for Clarity

A comma is recommended after "issues" on line 59 to make the sentence flow better.

-If you have any questions about translation or encounter any issues please [open an issue](https://github.com/Mail-0/Zero/issues) or join our [Discord server](https://discord.gg/NaK85MSzND)
+If you have any questions about translation or encounter any issues, please [open an issue](https://github.com/Mail-0/Zero/issues) or join our [Discord server](https://discord.gg/NaK85MSzND)
🧰 Tools
🪛 LanguageTool

[uncategorized] ~59-~59: A comma might be missing here.
Context: ...ions about translation or encounter any issues please [open an issue](https://github.c...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8ac39e9 and 045827f.

📒 Files selected for processing (2)
  • .github/TRANSLATION.md (1 hunks)
  • README.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
.github/TRANSLATION.md

[uncategorized] ~15-~15: A comma might be missing here.
Context: ... language you'd like to help with isn't listed you can open an issue and mention [@nee...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)


[uncategorized] ~19-~19: A comma might be missing here.
Context: ...as soon as possible, once you have been accepted you should get a Direct Message from `@...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)


[uncategorized] ~59-~59: A comma might be missing here.
Context: ...ions about translation or encounter any issues please [open an issue](https://github.c...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)

🔇 Additional comments (2)
README.md (1)

282-282: Added Translation Guide Link in Contributing Section

The new line inviting users to help translate Zero and linking to the translation guide is clear and well-placed. The relative path to .github/TRANSLATION.md appears correct.

.github/TRANSLATION.md (1)

1-62: Overall Quality

The translation guide is comprehensive, well-structured, and easy to follow. It provides clear steps and important guidelines for contributors. Great work on enhancing community localization efforts!

🧰 Tools
🪛 LanguageTool

[uncategorized] ~15-~15: A comma might be missing here.
Context: ... language you'd like to help with isn't listed you can open an issue and mention [@nee...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)


[uncategorized] ~19-~19: A comma might be missing here.
Context: ...as soon as possible, once you have been accepted you should get a Direct Message from `@...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)


[uncategorized] ~59-~59: A comma might be missing here.
Context: ...ions about translation or encounter any issues please [open an issue](https://github.c...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)

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: 0

🧹 Nitpick comments (2)
.github/TRANSLATION.md (2)

7-16: Getting Started Section Clarity

The "Getting Started" section offers a concise, step-by-step guide for new translators. Emphasizing the inclusion of the Discord tag is useful; however, you might consider bolding or otherwise highlighting that requirement further for clarity.


62-62: Minor Formatting Note

The final line ("62") appears without content. Please confirm if this is intentional or if it should be removed/adjusted to match the formatting of the rest of the document.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 045827f and 1d8dbf0.

📒 Files selected for processing (1)
  • .github/TRANSLATION.md (1 hunks)
🔇 Additional comments (6)
.github/TRANSLATION.md (6)

1-6: Introduction and Badge Verification

The introduction is clear and immediately informs the reader of the guide's purpose. The inclusion of the Crowdin badge is an effective visual cue. Please verify that the link (https://crowdin.com/project/0email) is current and correctly points to the 0.email project page.


17-25: Translation Process Workflow

This section clearly outlines the translation process once a translator’s application is approved. The step-by-step instructions are easy to follow and should help set proper expectations.


26-35: Detailed Translation Guidelines

The guidelines for maintaining format tags (variables, formatting tags, and plural forms) are comprehensive and well-articulated. This level of detail will assist translators in preserving the functionality of formatted strings.


36-43: Example Translation Demonstration

The provided JSON snippet example solidly demonstrates how to handle plural forms and variables. Ensure that the formatting of the code block remains valid JSON to avoid any potential confusion for translators referencing this guide.


49-56: Testing Your Translations Guidance

The "Testing Your Translations" section effectively communicates the necessary steps for translators to verify their contributions in context. Double-check that the relative link to the Quick Start Guide correctly navigates to the intended section in the README file.


57-61: Support and Community Assistance

The "Need Help?" section offers clear directions for obtaining assistance, including links to open an issue or join the Discord server. This is a good practice to support community engagement.

@hiheyhello123 hiheyhello123 merged commit f73d8ab into staging Mar 14, 2025
4 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Mar 14, 2025
@coderabbitai coderabbitai bot mentioned this pull request May 30, 2025
8 tasks
@coderabbitai coderabbitai bot mentioned this pull request Jun 29, 2025
28 tasks
@coderabbitai coderabbitai bot mentioned this pull request Jul 8, 2025
27 tasks
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