From 9356843e27672230bbf311c9a336c88d27cd5b56 Mon Sep 17 00:00:00 2001 From: doraeric Date: Wed, 26 Oct 2016 14:09:36 +0800 Subject: [PATCH] add zh-tw docs --- README.md | 2 +- .../zh-TW/project/CODE_OF_CONDUCT.md | 46 +++++++++++ .../zh-TW/project/CONTRIBUTING.md | 74 ++++++++++++++++++ docs-translations/zh-TW/project/README.md | 77 +++++++++++++++++++ 4 files changed, 198 insertions(+), 1 deletion(-) create mode 100644 docs-translations/zh-TW/project/CODE_OF_CONDUCT.md create mode 100644 docs-translations/zh-TW/project/CONTRIBUTING.md create mode 100644 docs-translations/zh-TW/project/README.md diff --git a/README.md b/README.md index dd0b209eb5c8..67a47854ebe4 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ [![devDependency Status](https://david-dm.org/electron/electron/dev-status.svg)](https://david-dm.org/electron/electron?type=dev) [![Join the Electron Community on Slack](http://atom-slack.herokuapp.com/badge.svg)](http://atom-slack.herokuapp.com/) -:memo: Available Translations: [Korean](https://github.com/electron/electron/tree/master/docs-translations/ko-KR/project/README.md) | [Simplified Chinese](https://github.com/electron/electron/tree/master/docs-translations/zh-CN/project/README.md) | [Brazilian Portuguese](https://github.com/electron/electron/tree/master/docs-translations/pt-BR/project/README.md) +:memo: Available Translations: [Korean](https://github.com/electron/electron/tree/master/docs-translations/ko-KR/project/README.md) | [Simplified Chinese](https://github.com/electron/electron/tree/master/docs-translations/zh-CN/project/README.md) | [Brazilian Portuguese](https://github.com/electron/electron/tree/master/docs-translations/pt-BR/project/README.md) | [Traditional Chinese](https://github.com/electron/electron/tree/master/docs-translations/zh-TW/project/README.md) The Electron framework lets you write cross-platform desktop applications using JavaScript, HTML and CSS. It is based on [Node.js](https://nodejs.org/) and diff --git a/docs-translations/zh-TW/project/CODE_OF_CONDUCT.md b/docs-translations/zh-TW/project/CODE_OF_CONDUCT.md new file mode 100644 index 000000000000..6eae666ab423 --- /dev/null +++ b/docs-translations/zh-TW/project/CODE_OF_CONDUCT.md @@ -0,0 +1,46 @@ +# 貢獻者行為守則契約 + +## 我們的承諾 + +為了營造一個開放和溫馨的環境，我們作為貢獻者和維護者，承諾對每個參與我們的項目和社區的人，提供不受騷擾的環境，無論年齡、身體大小、殘疾、自我認同種族、性別認同和表達、經驗水準、國籍，個人外貌，天生種族，宗教或生理性別和性取向。 + +## 我們的標準 + +有助於創造積極環境的行為包括: + +* 使用歡迎和包容性的語言 +* 尊重不同的觀點和經驗 +* 優雅地接受建設性的批評 +* 專住在為社群最好的事情上 +* 顯示對其他社區成員的同情 + +參與者不被許可的行為例子包括: + +* 使用性別化語言或圖像以及不歡迎的性別關注或其他更進一步的行為 +* 毀謗、侮辱、貶損的評論以及個人或政治攻擊 +* 公共或私人騷擾 +* 未經明確許可，發布他人的個資，如住址或電子信箱 +* 其他可以合理地認為在專業環境中不合適的行為 + +## 我們的責任 + +專案維護者負責澄清可接受的行為標準，並且應該對任何不可接受的行為採取適當且公平的糾正措施。 + +專案維護者有權利和責任刪除、編輯或拒絕與本行為準則不一致的評論、提交、代碼，維基編輯，問題和其他不在此列的貢獻。甚至暫時或永久禁止任何被認為是不當、威脅、攻擊性或有害的參與者。 + +## 範圍 + +當個人代表專案或其社群時，本行為準則適用於專案範圍或公共空間。代表專案或社群的例子包括使用官方電子郵件、透過官方社群帳號發文、或在線上或離線的活動擔任指定代表。專案的表現行為可由專案維護者進一步定義和澄清。 + +## 強制執行 + +濫用、騷擾或其他不可接受行為的實例可向專案團隊 [electron@github.com](mailto:electron@github.com) 報告。所有投訴將被審查和調查，並在被認為必要和適合情況下做出回應。專案團隊有義務對事件提報者保密。具體執行政策的進一步細節可以單獨公佈。 + +未真誠遵守或實施行為準則的專案維護者可能會面臨專案領導層成員所決定的暫時性或永久性影響。 + +## 來源 + +本行為準則改編自 [Contributor Covenant][homepage], 1.4版, 可從 [http://contributor-covenant.org/version/1/4][version] 獲得 + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/docs-translations/zh-TW/project/CONTRIBUTING.md b/docs-translations/zh-TW/project/CONTRIBUTING.md new file mode 100644 index 000000000000..46697812262e --- /dev/null +++ b/docs-translations/zh-TW/project/CONTRIBUTING.md @@ -0,0 +1,74 @@ +# Electron約定 + +:+1::tada: 首先，感謝抽出時間做出貢獻的每一個人! :tada::+1: + +該項目遵守貢獻者約定 [code of conduct](CODE_OF_CONDUCT.md)。 +我們希望貢獻者能遵守此約定。如果有發現任何不被接受的行為，請回報至electron@github.com(PS:請用英語)。 + +下在是一些用於改進Electron的指南。 +這些只是指導方針，而不是規則，做出你認為最適合的判斷，並隨時 +在 pull request 中提出對該文件的更改。 + +## 提交 Issues + +* 你可以在此創建一個 issue [here](https://github.com/electron/electron/issues/new)， +但在此之前，請閱讀以下注意事項，其中應包含盡可能多的細節。 +如果可以的話，請包括: + * 你所使用的 Electron 版本 + * 你所使用的系統 + * 如果適用，請包括:你做了什麼時發生了問題，以及你所預期的結果。 +* 其他有助於解決你的 issue 的選項: + * 截圖和動態GIF + * 終端機和開發工具中的錯誤訊息或警告。 + * 執行 [cursory search](https://github.com/electron/electron/issues?utf8=✓&q=is%3Aissue+) + 檢查是否已存在類似問題 + +## 提交 Pull Requests + +* 可以的話，在 pull request 包含截圖和動態GIF。 +* 遵守 JavaScript, C++, and Python [coding style defined in docs](/docs/development/coding-style.md). +* 使用 [Markdown](https://daringfireball.net/projects/markdown) 撰寫文件。 + 請參考 [Documentation Styleguide](/docs/styleguide.md). +* 使用簡單明瞭的提交訊息。請參考 [Commit Message Styleguide](#git-commit-messages). + +## 文件樣式 + +### 通用代碼 + +* 以空行做文件結尾。 +* 按照以下順序載入模組: + * 添加 Node Modules (參考 `path`) + * 添加 Electron Modules (參考 `ipc`, `app`) + * 本地模組(使用相對路徑) +* 按照以下的順序排序類別(class)的屬性: + * 類別的方法和屬性 (方法以 `@` 作為開頭) + * 實體(Instance)的方法和屬性 +* 避免使用平台相依代碼: + * 使用 `path.join()` 來連接檔案名稱。 + * 當需要使用臨時目錄時，使用 `os.tmpdir()` 而不是 `/tmp` 。 +* 在 function 結尾使用明確的 `return` 。 + * 不要使用 `return null`, `return undefined`, `null`, 或 `undefined` + +### Git 提交訊息 (鑑於進行Git提交時需要英文書寫，此處暫不翻譯) + +* Use the present tense ("Add feature" not "Added feature") +* Use the imperative mood ("Move cursor to..." not "Moves cursor to...") +* Limit the first line to 72 characters or less +* Reference issues and pull requests liberally +* When only changing documentation, include `[ci skip]` in the commit description +* Consider starting the commit message with an applicable emoji: + * :art: `:art:` when improving the format/structure of the code + * :racehorse: `:racehorse:` when improving performance + * :non-potable_water: `:non-potable_water:` when plugging memory leaks + * :memo: `:memo:` when writing docs + * :penguin: `:penguin:` when fixing something on Linux + * :apple: `:apple:` when fixing something on macOS + * :checkered_flag: `:checkered_flag:` when fixing something on Windows + * :bug: `:bug:` when fixing a bug + * :fire: `:fire:` when removing code or files + * :green_heart: `:green_heart:` when fixing the CI build + * :white_check_mark: `:white_check_mark:` when adding tests + * :lock: `:lock:` when dealing with security + * :arrow_up: `:arrow_up:` when upgrading dependencies + * :arrow_down: `:arrow_down:` when downgrading dependencies + * :shirt: `:shirt:` when removing linter warnings diff --git a/docs-translations/zh-TW/project/README.md b/docs-translations/zh-TW/project/README.md new file mode 100644 index 000000000000..dae51010d18b --- /dev/null +++ b/docs-translations/zh-TW/project/README.md @@ -0,0 +1,77 @@ +[![Electron Logo](http://electron.atom.io/images/electron-logo.svg)](http://electron.atom.io/) + +[![Travis Build Status](https://travis-ci.org/electron/electron.svg?branch=master)](https://travis-ci.org/electron/electron) +[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/kvxe4byi7jcxbe26/branch/master?svg=true)](https://ci.appveyor.com/project/Atom/electron) +[![devDependency Status](https://david-dm.org/electron/electron/dev-status.svg)](https://david-dm.org/electron/electron?type=dev) +[![Join the Electron Community on Slack](http://atom-slack.herokuapp.com/badge.svg)](http://atom-slack.herokuapp.com/) + +Electron框架讓你可以用JavaScript, HTML 和 CSS 編寫跨平台的應用程式。 +它是基於[Node.js](https://nodejs.org/)和[Chromium](http://www.chromium.org)， +並且被[Atom editor](https://github.com/atom/atom)及許多其他的[apps](http://electron.atom.io/apps)所使用。 + +請關注[@ElectronJS](https://twitter.com/electronjs)的Twitter以獲得重要公告。 + +該項目遵守貢獻者約定 [code of conduct](CODE_OF_CONDUCT.md)。 +我們希望貢獻者能遵守此約定。如果有發現任何不被接受的行為，請回報至electron@github.com(PS:請用英語)。 + +## 下載 + +預編譯的二進位檔和debug symbols版可以在[releases](https://github.com/electron/electron/releases)中找到， +其中包含Linux, Windows 和 macOS版的Electron。 + +你也可以用[`npm`](https://docs.npmjs.com/)安裝預編譯的二進位檔: + +```sh +# 在 $PATH 全域安裝 `electron` +npm install electron -g + +# 安裝為開發依賴 +npm install electron --save-dev +``` + +### 鏡像網站 + +- [中國](https://npm.taobao.org/mirrors/electron) + +## 文件 + +開發指南和API文件位於 +[docs](https://github.com/electron/electron/tree/master/docs)。 +它也包括如何編譯看改進Electron。 + +## 翻譯版文件 + +- [葡萄牙語－巴西](https://github.com/electron/electron/tree/master/docs-translations/pt-BR) +- [韓語](https://github.com/electron/electron/tree/master/docs-translations/ko-KR) +- [日語](https://github.com/electron/electron/tree/master/docs-translations/jp) +- [西班牙語](https://github.com/electron/electron/tree/master/docs-translations/es) +- [簡體中文](https://github.com/electron/electron/tree/master/docs-translations/zh-CN) +- [正體中文](https://github.com/electron/electron/tree/master/docs-translations/zh-TW) +- [土耳其](https://github.com/electron/electron/tree/master/docs-translations/tr-TR) +- [烏克蘭](https://github.com/electron/electron/tree/master/docs-translations/uk-UA) +- [俄語](https://github.com/electron/electron/tree/master/docs-translations/ru-RU) +- [法語](https://github.com/electron/electron/tree/master/docs-translations/fr-FR) + +## 快速開始 + +Clone 並使用 [`electron/electron-quick-start`](https://github.com/electron/electron-quick-start) +這個repo，以使用輕量化的Electron。 + +## 社群 + +你可以在以下位置提問並和社群成員互動: +- [`electron`](http://discuss.atom.io/c/electron) Atom論壇上的其中一區 +- `#atom-shell` Freenode的聊天頻道 +- [`Atom`](http://atom-slack.herokuapp.com/) Slack上的頻道 +- [`electron-br`](https://electron-br.slack.com) *(葡萄牙語－巴西)* +- [`electron-kr`](http://www.meetup.com/electron-kr/) *(韓語)* +- [`electron-jp`](https://electron-jp-slackin.herokuapp.com/) *(日語)* +- [`electron-tr`](http://www.meetup.com/Electron-JS-Istanbul/) *(土耳其)* +- [`electron-id`](https://electron-id.slack.com) *(印度尼西亞)* + +在 [awesome-electron](https://github.com/sindresorhus/awesome-electron) +查看由社群維護的清單，包括實用的應用程式、工具以及資源。 + +## 憑證 + +MIT © 2016 Github