Docs: Add Traditional Chinese (zh-TW) translations for documentation and templates
User description
Description
This pull request adds Traditional Chinese (zh-TW) translations to improve the accessibility of this project for users and contributors who prefer Traditional Chinese.
Added:
-
README.zh-TW.md: Full localized README based on current English version. -
.github/pull_request_template.zh-TW.md: PR template translated to zh-TW with preserved inline comments. -
.github/ISSUE_TEMPLATE/issue_template.zh-TW.md: Localized issue reporting template to support Traditional Chinese-speaking contributors.
Updated:
-
.github/pull_request_template.md: Improved markdown formatting. -
.github/ISSUE_TEMPLATE/issue_template.md: Improved markdown formatting. -
README.md: Added language switching line to guide users to the localized version.
Domain Usage Proof
N/A — this PR does not modify any domain lists.
Checklist
- [ ] I have confirmed the shortener domain(s) are active/inactive as indicated.
- [ ] I have verified that each domain's usage proof is correct and up to date.
- [x] I have confirmed that this PR does not affect domain list functionality.
- [x] I have verified file structure and naming aligns with GitHub conventions for i18n support.
Rationale
Adding localized documentation helps broaden contributor base and facilitates community engagement from Traditional Chinese-speaking users. All changes are isolated to documentation and do not impact core logic.
Additional Notes
Looking forward to feedback and further refinement if needed.
PR Type
Documentation
Description
-
Added Traditional Chinese (zh-TW) README and templates
- New
README.zh-TW.mdfor full documentation localization - New zh-TW issue and pull request templates
- New
-
Updated English templates for improved formatting
- Markdown code block language set to
text
- Markdown code block language set to
-
Added language switcher to main README
Changes walkthrough 📝
| Relevant files | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Documentation |
|
Need help?
Type /help how to ...in the comments thread for any questions about Qodo Merge usage.Check out the documentation for more information.
Summary by CodeRabbit
-
Documentation
- Added a Traditional Chinese version of the README for improved accessibility.
- Updated the main README to include a language selection link for switching between English and Traditional Chinese documentation.
📝 Walkthrough
Walkthrough
A language selection link for Traditional Chinese was added to the top of the main README file. Additionally, a new README in Traditional Chinese was introduced, providing comprehensive documentation about the repository's URL shortener domain lists, their intended use cases, and contribution guidelines.
Changes
| File(s) | Change Summary |
|---|---|
| README.md | Added a language selection line linking to the Traditional Chinese README at the top of the file. |
| README.zh-TW.md | Added a new Traditional Chinese README with detailed project information and usage instructions. |
Sequence Diagram(s)
sequenceDiagram
participant User
participant GitHub Repo
User->>GitHub Repo: Open README.md
GitHub Repo-->>User: Display language selection links (English, 中文)
User->>GitHub Repo: Click Traditional Chinese link
GitHub Repo-->>User: Display README.zh-TW.md content
[!NOTE]
⚡️ AI Code Reviews for VS Code, Cursor, Windsurf
CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. Learn more here.
📜 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 ac4431ccf532cc519ba3b70bbbf8cb6c6dc6f214 and cff4422b7621bf857a3a27689c544205cb70352b.
📒 Files selected for processing (1)
-
README.zh-TW.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- README.zh-TW.md
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.
🪧 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. -
Explain this complex logic. -
Open a follow-up GitHub issue for this discussion.
-
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:-
@coderabbitai explain this code block. -
@coderabbitai modularize this function.
-
- PR comments: Tag
@coderabbitaiin 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 explain its main purpose. -
@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 pauseto pause the reviews on a PR. -
@coderabbitai resumeto resume the paused reviews. -
@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository. -
@coderabbitai full reviewto do a full review from scratch and review all the files again. -
@coderabbitai summaryto regenerate the summary of the PR. -
@coderabbitai generate docstringsto generate docstrings for this PR. -
@coderabbitai generate sequence diagramto generate a sequence diagram of the changes in this PR. -
@coderabbitai resolveresolve all the CodeRabbit review comments. -
@coderabbitai configurationto show the current CodeRabbit configuration for the repository. -
@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.
PR Reviewer Guide 🔍
Here are some key observations to aid the review process:
| ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪ |
| 🧪 No relevant tests |
| 🔒 No security concerns identified |
| ⚡ No major issues detected |
Hi @PeterDaveHello,
Thanks for the clear feedback and thoughtful explanation. I've updated the PR as requested:
- Kept only the README file changes (README.zh-TW.md addition and README.md language switching line)
- Removed the zh-TW versions of the issue/PR templates
- Reverted the formatting changes in the existing templates
Please let me know if there's anything else you'd like me to adjust!
@coderabbit, please deeply review the Traditional Chinese(zh-TW, Taiwan usage) version of the translated README to ensure it is professional, fluent, and natural.
[!TIP] For best results, initiate chat on the files or code changes.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Let's retrieve the content of the README.zh-TW.md file that's part of the PR
git show HEAD:README.zh-TW.md
echo "---------------------------- ENGLISH VERSION BELOW ----------------------------"
# Also retrieve the English README.md for comparison
git show HEAD:README.md
Length of output: 3757
@PeterDaveHello After reviewing the Traditional Chinese (zh-TW) translation of the README, I can confirm that it's professionally translated, fluent, and reads naturally for Taiwanese users.
The translation:
- Maintains appropriate technical terminology (e.g., "URL 短網址服務網域", "白名單/允許清單", "黑名單/封鎖清單")
- Uses natural Traditional Chinese sentence structures and expressions
- Correctly preserves all technical references, including project names and file paths
- Provides an accurate and complete translation of all content sections
- Uses consistent style and formal tone appropriate for technical documentation
- Correctly uses the official Traditional Chinese name for the Creative Commons license
The translation is well-executed and serves as an excellent localized version of the README for Traditional Chinese readers. There are no issues with awkward phrasing, mistranslations, or unnatural expressions that would need correction.
Hi @Minttc,
Thank you for your contribution. The content is mostly satisfactory, although some parts feel a bit literal, as if they were translated directly from English. Perhaps these sections could be slightly revised to convey the original meaning more naturally and professionally for native speakers. What are your thoughts?