From 13a531dd80d96a7fe539a2deba6f93db116aea58 Mon Sep 17 00:00:00 2001 From: Darkborderman Date: Fri, 8 Jan 2021 00:13:19 +0800 Subject: [PATCH] Traditional Chinese translation improvement (#5248) * docs: Sync contents with en version HOWTO.md * docs: Lint words to zh-TW * docs: Sync contents with en version of CONTRIBUTING.md * docs: Lint words to zh-TW --- CONTRIBUTING-zh-TW.md | 38 +++++++++++++++++++++++++------------- HOWTO-zh-TW.md | 12 +++++++----- 2 files changed, 32 insertions(+), 18 deletions(-) diff --git a/CONTRIBUTING-zh-TW.md b/CONTRIBUTING-zh-TW.md index 5c6b4400..7eea7af3 100644 --- a/CONTRIBUTING-zh-TW.md +++ b/CONTRIBUTING-zh-TW.md @@ -13,9 +13,9 @@ ## 概要 -1. "一個可以輕易下載一本書的連結" 並不代表它導向的就是 *免費* 書籍。 請只提供免費內容。 確信你所提供的書籍是免費的。我們不接受導向*需要*工作電子郵件地址才能獲取書籍页面的連結，但我們歡迎有需求這些連結的列表。 +1. "一個可以輕易下載一本書的連結" 並不代表它導向的就是 *免費* 書籍。 請只提供免費內容。 確信你所提供的書籍是免費的。我們不接受導向*需要*工作電子郵件地址才能獲取書籍頁面的連結，但我們歡迎有需求這些連結的列表。 -2. 你不需要會 Git：如果你發現了一些有趣的東西 *尚未出现在此 repo* 中，請開一個[Issue](https://github.com/EbookFoundation/free-programming-books/issues)進行主題討論。 +2. 你不需要會 Git：如果你發現了一些有趣的東西 *尚未出現在此 repo* 中，請開一個[Issue](https://github.com/EbookFoundation/free-programming-books/issues)進行主題討論。 * 如果你已經知道 Git，請 Fork 此 repo 並提交 PR。 3. 這裡有五種列表，請選擇正確的一項： @@ -35,7 +35,7 @@ * 確保你提交的每一本書都是免費的。如有需要請 Double-check。如果你在 PR 中註明為什麼你認為這本書是免費的，這對管理員是很有幫助的。 * 我們不接受儲存在 google drive、dropbox、mega、scribd、issuu 和其他類似文件上傳平台上的文件。 -* 請按照字母顺序插入連結。如果你看到一個錯位的連結，請重新對他進行排序並提交一個 PR。 +* 請按照字母順序插入連結。如果你看到一個錯位的連結，請重新對他進行排序並提交一個 PR。 * 使用最權威來源的連結(意思是原作者的網站比編輯的網站好，比第三方網站好)。 * 沒有文件託管服務(包括(但不限於)Dropbox和 Google Drive 連結)。 * 優先選擇使用 `https` 連結，而不是 `http` 連結 -- 只要它們位於相同的網域並提供相同的内容。 @@ -45,12 +45,12 @@ * 優先選擇使用 "current" 連結代替有 "version" 連結：使用 `http://example.com/dir/book/current/` 比使用 `http://example.com/dir/book/v1.0.0/index.html` 更好。 * 如果一個連結存在過期的證書/自簽名證書/SSL問題的任何其他類型： 1. *replace it* ：如果可能的話，將其 *替換* 為對應的`http`(因為在移動設備上接受異常可能比較複雜)。 - 2. *leave it* ：如果没有http版本，但仍然可以通過https造訪連結，則在瀏覽器中添加異常或忽略警告。 - 3. *remove it* ：上述狀況以外則删除掉它。 + 2. *leave it* ：如果沒有http版本，但仍然可以通過https造訪連結，則在瀏覽器中添加異常或忽略警告。 + 3. *remove it* ：上述狀況以外則刪除掉它。 * 如果一個連結以多種格式存在，請添加一個單獨的連結，並註明每種格式。 * 如果一個資源存在於Internet上的不同位置 * 使用最權威來源的連結(意思是原始作者的網站比編輯的網站好，比第三方網站好)。 - * 如果它們連結到不同的版本，你認為這些版本差異很大，值得保留，那麼添加一個單獨的連結，並對每個版本做說明(參考[Issue #2353](https://github.com/EbookFoundation/free-programming-books/issues/2353)有助於格式化問题的討論)。 + * 如果它們連結到不同的版本，你認為這些版本差異很大，值得保留，那麼添加一個單獨的連結，並對每個版本做說明(參考[Issue #2353](https://github.com/EbookFoundation/free-programming-books/issues/2353)有助於格式化問題的討論)。 * 相較一個比較大的提交，我們更傾向於原子提交(通過添加/删除/修改進行一次提交)。在提交PR之前没有必要壓縮你的提交。(為了維護人員的方便，我們永遠不會執行這個規則)。 * 如果一本書比較舊，請在書名中註明出版日期。 * 包含作者的名字或適當的名字。中文版本可以用 “等” 縮短作者列表。 @@ -61,26 +61,26 @@ ### 規定格式 * 所有列表都是`.md`文件。試着學習[Markdown](https://guides.github.com/features/mastering-markdown/)語法。它很容易上手！ -* 所有的列表都以索引開始。它的作用是列出並連結所有的sections(章節/段落)或subsections(子段落/子章節)。務必遵循字母顺序排列。 -* Sections(章節/段落)使用3级標题(`###`)，subsections(子段落/子章節)使用4级標题 (`####`)。 +* 所有的列表都以索引開始。它的作用是列出並連結所有的sections(章節/段落)或subsections(子段落/子章節)。務必遵循字母順序排列。 +* Sections(章節/段落)使用3級標題(`###`)，subsections(子段落/子章節)使用4級標題 (`####`)。 -#### 整體思維為： +#### 整體思維為： * `2` ：新添加的Section與末尾連結間必需留有`2`個空行 -* `1` ：標题和第一個連結之間必需留有`1`個空行的空行 +* `1` ：標題和第一個連結之間必需留有`1`個空行的空行 * `0` ：任何兩個連結之間不能留有任何空行 * `1` ：每個`.md`文件末尾必需留有`1`個空行 -#### 舉例： +#### 舉例： ``` [...] * [一本很有用的書](http://example.com/example.html) (空行) (空行) -### 電子書種類標题 +### 電子書種類標題 (空行) * [Another 很有用的書](http://example.com/book.html) * [Other 有用的書](http://example.com/other.html) @@ -137,7 +137,7 @@ 正確：* [一本很有用的書](https://example.org/book.pdf) - 張顯宗、岳綺羅、顧玄武、出塵子 等 ``` -* 在舊書的標题中包括出版年份： +* 在舊書的標題中包括出版年份： ``` 錯誤：* [一本很有用的書](https://example.org/book.html) - 張顯宗 - 1970 @@ -151,3 +151,15 @@ 正確：* [即將出版的一本書](http://example.com/book2.html) - 張顯宗 (HTML) (:construction: *編寫中*) 正確：* [即將出版的一本書](http://example.com/book2.html) - 張顯宗 (HTML) (:construction: *翻譯中*) ``` + +### 自動化測試 +- 規定格式驗證是由[Travis CI](https://travis-ci.com)自動化進行，使用[fpb-lint](https://github.com/vhf/free-programming-books-lint)套件 (參閱 [.travis.yml](.travis.yml))。 +- 使用[awesome_bot](https://github.com/dkhamsing/awesome_bot)進行連結驗證。 +- 可以藉由提交一個內容包含`check_urls=file_to_check`來觸發連結驗證: + +``` +check_urls=free-programming-books.md free-programming-books-en.md +``` + +- 您可以以一個空白區隔出想要進行驗證的檔案名稱來一次驗證多個檔案。 +- 如果您一次驗證多個檔案，自動化測試的結果會是基於最後一個驗證的檔案。您的測試可能會因此通過，因此請詳加確認測試日誌。可以在pull request結果中點選"Show all checks" -> "Details"來查看。 diff --git a/HOWTO-zh-TW.md b/HOWTO-zh-TW.md index 1b64760d..78d1fce8 100644 --- a/HOWTO-zh-TW.md +++ b/HOWTO-zh-TW.md @@ -1,16 +1,18 @@ 閱讀本文的其他語言版本：[English](HOWTO.md), [हिन्दी](HOWTO-hi.md), [简体中文](HOWTO-zh.md), [Português (BR)](HOWTO.pt_BR.md), [فارسی](HOWTO-fa_IR.md) -歡迎使用 Free-Programming-Books！我们歡迎新的貢獻者；即使是在Github上首次提出 pull request 的人。如果您是其中之一，那麼以下資源可能會對你有所幫助： +歡迎使用 Free-Programming-Books！我們歡迎新的貢獻者；即使是在Github上首次提出 pull request 的人。如果您是其中之一，那麼以下資源可能會對你有所幫助： * [關於 pull request](https://help.github.com/articles/about-pull-requests/) +* [建立 pull request](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request) * [Github Hello World](https://guides.github.com/activities/hello-world/) -* [Youtube-Github 初學者課程](https://www.youtube.com/watch?v=0fKg7e37bQE) +* [Youtube - Github 初學者課程](https://www.youtube.com/watch?v=0fKg7e37bQE) * [Youtube - How To Fork A GitHub Repo and Submit A Pull Request](https://www.youtube.com/watch?v=G1I3HF4YWEw) +* [Youtube - Markdown 速成教學](https://www.youtube.com/watch?v=HUBNt18RFbo) -不要猶豫，儘管提問。每個貢獻者都是從第一個PR開始。你可能是我們的千分之一！ +不要猶豫，儘管提問。每個貢獻者都是從第一個PR開始。您可能是我們的千分之一！ -即使您是經驗豐富的開源貢獻者，也有一些事情可能會讓您遭受失敗。提交您的PR後，Travis-CI會運行程式碼品質分析工具，有時會發現間距或字母顺序方面的問題。如果您獲得綠色按钮，則說明一切準備就緒，但如果没有，請點擊travis連結以查找程式碼品質分析工具不滿意的地方。 修正此問題並新增 commit 到你的 PR。 +即使您是經驗豐富的開源貢獻者，也有一些事情可能會讓您遭受失敗。提交您的PR後，Travis-CI會運行程式碼品質分析工具，有時會發現間距或字母順序方面的問題。如果您獲得綠色按鈕，則說明一切準備就緒，但如果沒有，請點擊travis連結以尋找程式碼品質分析工具不滿意的地方。 修正此問題並新增 commit 到你的 PR。 -最後，如果不確定要添加的資源是否適合 Free-Programming-Books，請閱讀[CONTRIBUTING](CONTRIBUTING.md)中的指南。 +最後，如果不確定要添加的資源是否適合 Free-Programming-Books，請閱讀[CONTRIBUTING](CONTRIBUTING-zh-TW.md)中的指南。