Docs: Add Traditional Chinese (zh-TW) translations for documentation and templates #135
Conversation
- Add zh-TW version of issue template - Add zh-TW version of pull request template - Update existing templates formatting - Update zh-TW README content for readability improvements
dosubot
bot
added
the
size:M
📝 WalkthroughWalkthroughThis update introduces Traditional Chinese versions of the issue and pull request templates, as well as a full Traditional Chinese README. It also updates the English README to include a language selection link. Additionally, the code block formatting in existing templates is changed to explicitly specify plain text for certain sections. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant GitHub
participant Maintainers
User->>GitHub: Selects issue or PR template (English or Traditional Chinese)
GitHub-->>User: Presents chosen template for issue/PR submission
User->>GitHub: Submits issue/PR with structured information
GitHub->>Maintainers: Notifies about new issue/PR
Maintainers-->>User: Review and respond based on submitted information
Possibly related PRs
Suggested labels
Tip ⚡️ Faster reviews with caching
Enjoy the performance boost—your workflow just got faster. 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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
README.zh-TW.md (2)
1-4: Add self-link for Traditional Chinese toggle
The language toggle currently links only to the English README and leaves “繁體中文” unlinked. Consider making it a clickable link toREADME.zh-TW.mdfor consistency and usability:- 🌐 [English](./README.md) | 繁體中文 + 🌐 [English](./README.md) | [繁體中文](./README.zh-TW.md)
33-36: Approve license section and ensure EOF newline
The license notice is accurately translated and correctly linked. Please ensure there is a trailing newline at the end of the file for compatibility with POSIX tooling.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
.github/ISSUE_TEMPLATE/issue_template.md(1 hunks).github/ISSUE_TEMPLATE/issue_template.zh-TW.md(1 hunks).github/pull_request_template.md(1 hunks).github/pull_request_template.zh-TW.md(1 hunks)README.md(1 hunks)README.zh-TW.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
.github/ISSUE_TEMPLATE/issue_template.zh-TW.md
[uncategorized] ~18-~18: 您的意思是“"不"驟”？
Context: ...ctual-domain.com/page1 2. ... ``` ## 驗證步驟 - [ ] 已確認所回報的網域正確且與短網址服務用途相關。 - [ ] 已...
(BU)
🔇 Additional comments (11)
.github/pull_request_template.md (1)
9-13: Use explicit language for code fences for clarity
Changing the fenced code block to ```text explicitly marks these as plain text examples, improving readability and consistency across GitHub’s markdown renderer.README.md (1)
3-4: Add language selector for Traditional Chinese
The new “🌐 English | 繁體中文” line is well-placed immediately below the title and above the badges, making it easy for users to switch languages. Verify that the relative link resolves correctly on GitHub..github/ISSUE_TEMPLATE/issue_template.md (1)
13-16: Pin code blocks to plain text for consistency
Updating the “Verification Examples” section to use ```text aligns it with the pull request template and clarifies that these are plain URL examples..github/ISSUE_TEMPLATE/issue_template.zh-TW.md (1)
1-26: Approve Traditional Chinese issue template localization
The new zh-TW template faithfully mirrors the English structure, provides clear guidance in Traditional Chinese, and uses proper markdown formatting.🧰 Tools
🪛 LanguageTool
[uncategorized] ~18-~18: 您的意思是“"不"驟”？
Context: ...ctual-domain.com/page1 2. ... ``` ## 驗證步驟 - [ ] 已確認所回報的網域正確且與短網址服務用途相關。 - [ ] 已...(BU)
.github/pull_request_template.zh-TW.md (1)
1-27: Approve Traditional Chinese pull request template localization
The added zh-TW pull request template follows the English version’s layout, offers clear instructions in Traditional Chinese, and is formatted consistently.README.zh-TW.md (6)
5-7: Verify Travis CI badge branch reference
The Build Status badge points to themasterbranch (.../master.svg). If your repository’s default branch has been renamed tomain, update this URL to prevent a broken badge link.
8-11: Approve introduction translation and structure
The introductory paragraph is accurately translated and follows the same structure as the English README. Line breaks and emphasis are clear.
12-13: Confirm existence of referenced files
You mention thelistandinactivefiles—please verify these filenames and their paths exactly match the repository’s layout so users can locate them without confusion.
14-20: Approve direct links formatting
The “直接連結” section correctly uses angle-bracket links to present raw file URLs clearly. This mirrors the English version’s approach.
21-28: Approve usage scenarios section
The “使用情境” bullet list is well-translated and aligns perfectly with the English README’s use-case examples.
29-32: Approve contribution guidelines translation
The “貢獻” section effectively invites issues and pull requests, preserving the structure and tone of the English template.
Minttc
changed the title
There was a problem hiding this comment.
Pull Request Overview
This pull request adds Traditional Chinese (zh-TW) translations for documentation and templates to improve accessibility for Traditional Chinese-speaking users.
- Added localized README and issue/pull request templates in Traditional Chinese.
- Updated the English README and templates with improved markdown formatting and a language switcher.
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| README.zh-TW.md | New full Traditional Chinese localized README |
| README.md | Added language switcher link for Traditional Chinese |
| .github/pull_request_template.zh-TW.md | New Traditional Chinese PR template |
| .github/pull_request_template.md | Updated markdown formatting of PR template |
| .github/ISSUE_TEMPLATE/issue_template.zh-TW.md | New Traditional Chinese issue template |
| .github/ISSUE_TEMPLATE/issue_template.md | Updated markdown formatting of issue template |
There was a problem hiding this comment.
Based on the context and your requirements, here's a draft response:
Hi @Minttc,
Thanks for being interested in contributing to this project! Because of the nature of this project's primary users (DNS providers, system administrators, and technical users who are generally comfortable with English), having multilingual issue/PR templates would add maintenance overhead without bringing significant benefits.
However, I do appreciate the effort to make the project more accessible. The README translation could be valuable for reaching a broader audience and helping them understand the project's purpose. Would you be open to modifying this PR to:
- Keep only the README.zh-TW.md addition
- Remove the issue/PR templates in zh-TW
- Revert the code block formatting changes in the existing templates (they work fine as-is)
Let me know what you think!
|
Hi @PeterDaveHello, Thanks for the clear feedback and thoughtful explanation.
Please let me know if there's anything else you'd like me to adjust! |
There was a problem hiding this comment.
Pull Request Overview
This pull request introduces Traditional Chinese (zh-TW) localized documentation to improve accessibility for Traditional Chinese-speaking users.
- Added a fully translated README file (README.zh-TW.md)
- Updated the main README to include a language switcher link to access the localized documentation
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.zh-TW.md | New Traditional Chinese localized README content added |
| README.md | Updated with a language switcher link for accessing zh-TW README |
|
@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: 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:
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. |
| [](https://app.travis-ci.com/PeterDaveHello/url-shorteners) | ||
| [](https://github.com/PeterDaveHello/url-shorteners/blob/master/LICENSE) | ||
|
|
||
| 這是一個包含逾千個 URL 短網址服務網域的完整清單，可用於建立白名單/允許清單、黑名單/封鎖清單，或作為網域可信度評估等多種用途。此清單已被 NextDNS、RethinkDNS、ControlD、dnslow.me 及各個 OSINT 專案採用。這些高品質清單旨在強化網路安全、隱私保護及降低網域風險評估中的誤判。請在使用這些清單時自行斟酌風險。 |
There was a problem hiding this comment.
@coderabbitai, this line doesn't look fluent and natural enough, please suggest.
There was a problem hiding this comment.
@PeterDaveHello 這段文字確實可以調整得更自然流暢。以下是我的建議：
這份完整清單收錄了超過上千個 URL 短網址服務網域，適用於建立白名單（允許清單）、黑名單（封鎖清單），或進行網域可信度評估等用途。NextDNS、RethinkDNS、ControlD、dnslow.me 以及多個 OSINT 專案皆已採用此清單。這些精心整理的清單有助於加強網路安全、保護隱私，並減少網域風險評估時的誤判。使用時請自行評估相關風險。
主要調整包括：
- 改善開頭句式結構，使用「這份完整清單收錄了」比「這是一個包含」更自然
- 使用括號代替斜線來表示替代詞
- 調整句子結構和詞語選擇，使整體閱讀更為順暢
- 保留所有原始的技術含義和重要信息
There was a problem hiding this comment.
/ask
Make suggestions to ensure the line looks fluent and natural for Taiwanese Traditional Chinese(zh-TW) readers.
There was a problem hiding this comment.
The line appears to be a well-written Traditional Chinese (zh-TW) introduction to the URL shorteners project. However, I can suggest a few minor adjustments to make it more fluent and natural for Taiwanese readers:
- Consider breaking the long sentence into shorter ones for better readability.
- The term "白名單/允許清單" (whitelist/allowlist) and "黑名單/封鎖清單" (blacklist/blocklist) uses both traditional and newer inclusive terminology, which is good practice.
- For the final sentence about risk, a slightly more natural phrasing could be used.
Here's a suggested revision:
這是一個包含逾千個 URL 短網址服務網域的完整清單。它可用於建立白名單/允許清單、黑名單/封鎖清單，或作為網域可信度評估等多種用途。此清單已被 NextDNS、RethinkDNS、ControlD、dnslow.me 及各個 OSINT 專案採用。這些高品質清單旨在強化網路安全、提升隱私保護，並降低網域風險評估中的誤判率。使用時請依據自身需求評估適用性。
The changes are subtle but improve readability while maintaining the original meaning and technical accuracy.
There was a problem hiding this comment.
Skipped: comment is from another GitHub bot.
There was a problem hiding this comment.
@PeterDaveHello 以下提供三種不同風格的改寫建議，皆針對台灣讀者的語言習慣進行調整：
建議一（簡潔直接風格）：
本專案彙整了超過千筆 URL 短網址服務網域，可作為白名單（允許清單）、黑名單（封鎖清單）使用，或作為評估網域可信度的參考。此清單已獲 NextDNS、RethinkDNS、ControlD、dnslow.me 及多個 OSINT 專案採用，能有效增強網路安全、提升隱私保護，並減少網域風險評估的誤判率。使用時請自行評估相關風險。
建議二（流暢自然風格）：
這裡收集了上千個 URL 短網址服務網域，形成一份完整清單，您可將它用於建立白名單（又稱允許清單）、黑名單（又稱封鎖清單），或是在評估網域可信度時作為參考依據。NextDNS、RethinkDNS、ControlD、dnslow.me 等服務及各種 OSINT 專案都已採用此清單。這些經過精心整理的資料能協助強化您的網路安全防護，增進隱私保護，同時降低在網域風險評估過程中的誤判情況。請在使用時自行評估相關風險。
建議三（專業明確風格）：
本清單完整收錄逾千個 URL 短網址服務網域，適合用於：建立白名單（即允許清單）、設定黑名單（即封鎖清單），或是進行網域可信度評估等多項應用。目前 NextDNS、RethinkDNS、ControlD、dnslow.me 以及眾多 OSINT 專案均已導入使用。這些高品質資料有助於提升網路安全性、強化隱私保護，並能在網域風險評估中降低誤判可能。使用者請自行評估使用風險。
這三種版本各有特色，您可以選擇最符合專案風格的一種，或是從中取長補短進行調整。
There was a problem hiding this comment.
@Minttc please take a look.
There was a problem hiding this comment.
Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!
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
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
README.zh-TW.mdfor full documentation localizationUpdated English templates for improved formatting
textAdded language switcher to main README
Changes walkthrough 📝
README.zh-TW.md
Add Traditional Chinese localized READMEREADME.zh-TW.md
issue_template.zh-TW.md
Add zh-TW localized issue template.github/ISSUE_TEMPLATE/issue_template.zh-TW.md
pull_request_template.zh-TW.md
Add zh-TW localized pull request template.github/pull_request_template.zh-TW.md
README.md
Add language switcher to READMEREADME.md
issue_template.md
Improve code block formatting in issue template.github/ISSUE_TEMPLATE/issue_template.md
textpull_request_template.md
Improve code block formatting in PR template.github/pull_request_template.md
textSummary by CodeRabbit