Skip to content

add a Chinese version readme#887

Closed
imnotnoahhh wants to merge 3 commits intoMail-0:mainfrom
imnotnoahhh:main
Closed

add a Chinese version readme#887
imnotnoahhh wants to merge 3 commits intoMail-0:mainfrom
imnotnoahhh:main

Conversation

@imnotnoahhh
Copy link

@imnotnoahhh imnotnoahhh commented May 6, 2025

READ CAREFULLY THEN REMOVE

Remove bullet points that are not relevant.

PLEASE REFRAIN FROM USING AI TO WRITE YOUR CODE AND PR DESCRIPTION. IF YOU DO USE AI TO WRITE YOUR CODE PLEASE PROVIDE A DESCRIPTION AND REVIEW IT CAREFULLY. MAKE SURE YOU UNDERSTAND THE CODE YOU ARE SUBMITTING USING AI.

  • Pull requests that do not follow these guidelines will be closed without review or comment.
  • If you use AI to write your PR description your pr will be close without review or comment.
  • If you are unsure about anything, feel free to ask for clarification.

Description

Please provide a clear description of your changes.


Type of Change

Please delete options that are not relevant.

  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature with breaking changes)
  • 📝 Documentation update
  • 🎨 UI/UX improvement
  • 🔒 Security enhancement
  • ⚡ Performance improvement

Areas Affected

Please check all that apply:

  • Email Integration (Gmail, IMAP, etc.)
  • User Interface/Experience
  • Authentication/Authorization
  • Data Storage/Management
  • API Endpoints
  • Documentation
  • Testing Infrastructure
  • Development Workflow
  • Deployment/Infrastructure

Testing Done

Describe the tests you've done:

  • Unit tests added/updated
  • Integration tests added/updated
  • Manual testing performed
  • Cross-browser testing (if UI changes)
  • Mobile responsiveness verified (if UI changes)

Security Considerations

For changes involving data or authentication:

  • No sensitive data is exposed
  • Authentication checks are in place
  • Input validation is implemented
  • Rate limiting is considered (if applicable)

Checklist

  • I have read the CONTRIBUTING document
  • My code follows the project's style guidelines
  • I have performed a self-review of my code
  • I have commented my code, particularly in complex areas
  • I have updated the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix/feature works
  • All tests pass locally
  • Any dependent changes are merged and published

Additional Notes

Add any other context about the pull request here.

Screenshots/Recordings

Add screenshots or recordings here if applicable.


By submitting this pull request, I confirm that my contribution is made under the terms of the project's license.

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive Chinese-language README, including project overview, features, setup instructions, technology stack, environment configuration, and contribution guidelines.

@vercel
Copy link

vercel bot commented May 6, 2025

@qinfuyao is attempting to deploy a commit to the Zero Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 6, 2025

Walkthrough

A new Chinese-language README file (README-zh-cn.md) was added, providing detailed documentation for the Zero project. The file includes project introduction, features, technology stack, setup instructions, environment configuration, database setup, contribution guidelines, translation instructions, acknowledgments, and contributor information. No code or public API changes were made.

Changes

File(s) Change Summary
README-zh-cn.md Added a comprehensive Chinese-language README covering project overview, setup, configuration, and contribution details.

Sequence Diagram(s)

Not applicable: Only documentation was added, with no changes to control flow or features.

Possibly related PRs

  • updated readme #518: Updates and reorganizes the existing English README.md, closely related as both PRs enhance project documentation.
  • Update README.md #396: Modifies the English README for the Zero project; related through documentation updates.
  • Update README.md #462: Updates version requirements and contribution guidelines in the English README.md, sharing a documentation focus.

Poem

In a warren of docs, a new path appears,
Chinese words guide you—no need for fears!
Zero’s story now told in a global embrace,
Setup, stack, and secrets—find your place.
So hop through the README, east or west,
With every new language, we welcome more guests!
🐇📖


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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: 4

🧹 Nitpick comments (3)
README-zh-cn.md (3)

259-273: 统一静态资源路径

顶栏和底部使用了不同的资源路径(apps/mail/public/... vs public/...),可能导致图片无法加载。建议将底部 logo 的 src 路径统一为与顶部一致的相对路径,例如 apps/mail/public/...

- <img src="public/vercel.png" alt="Vercel" width="96"/>
+ <img src="apps/mail/public/vercel.png" alt="Vercel" width="96"/>

- <img src="public/better-auth.png" alt="Better Auth" width="96"/>
+ <img src="apps/mail/public/better-auth.png" alt="Better Auth" width="96"/>

- <img src="public/drizzle-orm.png" alt="Drizzle ORM" width="96"/>
+ <img src="apps/mail/public/drizzle-orm.png" alt="Drizzle ORM" width="96"/>

- <img src="public/coderabbit.png" alt="Coderabbit AI" width="96"/>
+ <img src="apps/mail/public/coderabbit.png" alt="Coderabbit AI" width="96"/>

247-252: 本地化链接文本

“contributing guide”和“translation guide”未翻译成中文,建议改为“贡献指南”和“翻译指南”以保持语言一致性。

- 请参阅 [contributing guide](.github/CONTRIBUTING.md).
+ 请参阅 [贡献指南](.github/CONTRIBUTING.md)。

- 如果您想帮助将Zero翻译成其他语言,请查看我们的 [translation guide](.github/TRANSLATION.md).
+ 如果您想帮助将 Zero 翻译成其他语言,请查看我们的 [翻译指南](.github/TRANSLATION.md)。

253-277: 翻译剩余英文标题和文案

“Star History”和“🤍 The team”全英文部分未翻译,建议译为“Star 历史”和“🤍 团队”,并将英文说明改成中文,以提升一致性。

- ## Star History
+ ## Star 历史

- ## 🤍 The team
+ ## 🤍 团队

- Curious who makes Zero? Here are our [contributors and maintainers](https://0.email/contributors)
+ 好奇是谁在构建 Zero?请查看我们的 [贡献者和维护者](https://0.email/contributors)
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d73ebfa and ffb16dd.

📒 Files selected for processing (1)
  • README-zh-cn.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
README-zh-cn.md

[uncategorized] ~100-~100: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:相同"地"设置
Context: ...供一个预先安装了所有依赖项的完整配置的开发环境。这对于确保团队中的每个人都有相同的设置是很好的。 1. 先决条件 - [Docker](http...

(wb4)

🪛 markdownlint-cli2 (0.17.2)
README-zh-cn.md

217-217: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)

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

🧹 Nitpick comments (3)
README-zh-cn.md (3)

100-101: Nitpick: Refine Chinese phrasing for clarity
“团队中的每个人都有相同的设置是很好的”略显口语化,建议更改为:

- 团队中的每个人都有相同的设置是很好的。
+ 团队中的每个人都能拥有相同的设置,这将非常有利。
🧰 Tools
🪛 LanguageTool

[uncategorized] ~100-~100: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:相同"地"设置
Context: ...供一个预先安装了所有依赖项的完整配置的开发环境。这对于确保团队中的每个人都有相同的设置是很好的。 1. 先决条件 - [Docker](http...

(wb4)


121-127: Fix code fence for troubleshooting commands
The snippet uses single backticks instead of a fenced code block with language. Update for proper rendering and syntax highlighting.

-     `bash
-     rm -rf node_modules
-     rm bun.lockb
-     bun install
-     `
+    ```bash
+    rm -rf node_modules
+    rm bun.lockb
+    bun install
+    ```

217-219: Add language identifier to code fence
The database connection snippet is missing a language tag, which causes markdownlint MD040. Specify env for clarity.

-   ```
+  ```env
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

217-217: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ffb16dd and f59bf5d.

📒 Files selected for processing (1)
  • README-zh-cn.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
README-zh-cn.md

[uncategorized] ~100-~100: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:相同"地"设置
Context: ...供一个预先安装了所有依赖项的完整配置的开发环境。这对于确保团队中的每个人都有相同的设置是很好的。 1. 先决条件 - [Docker](http...

(wb4)

🪛 markdownlint-cli2 (0.17.2)
README-zh-cn.md

217-217: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)

🔇 Additional comments (1)
README-zh-cn.md (1)

2-5:

Details

✅ Verification successful

Verify asset paths for dark/light logos
Ensure the referenced image files exist at the specified paths; broken links will prevent the logo from rendering.


🏁 Script executed:

#!/bin/bash
# Check that each src in <source> and <img> tags points to an existing file
grep -Eo 'src(?:set)?="([^"]+)"' README-zh-cn.md | sed -E 's/.*="([^"]+)"/\1/' | while read -r file; do
  if [ ! -f "$file" ]; then
    echo "Missing asset: $file"
  fi
done

Length of output: 413


🏁 Script executed:

#!/bin/bash
# Search for the white-icon.svg and black-icon.svg assets in the repository
echo "Searching for white-icon.svg"
fd white-icon.svg 2>/dev/null || find . -type f -name white-icon.svg
echo "Searching for black-icon.svg"
fd black-icon.svg 2>/dev/null || find . -type f -name black-icon.svg

Length of output: 237


Asset paths verified for dark/light logos

  • README-zh-cn.md references:
    • apps/mail/public/white-icon.svg
    • apps/mail/public/black-icon.svg
      Both files exist in the repository; no broken links detected.

@MrgSub
Copy link
Collaborator

MrgSub commented May 16, 2025

@qinfuyao please use staging

@MrgSub MrgSub closed this May 16, 2025
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