Skip to content

Commit c9f9fa4

Browse files
adrianliawadrianliaw
committed
Include basic How To Contribute section and Documentation Contribution Agreement in README
1 parent d4d7f92 commit c9f9fa4

File tree

1 file changed

+110
-17
lines changed

1 file changed

+110
-17
lines changed

‎README.rst

+110-17
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
=======================================
12
Python 官方說明文件臺灣繁體中文翻譯計畫
23
=======================================
34

@@ -10,41 +11,133 @@ Python 3.6 為翻譯的對象，**暫時不考慮 Python 2.7 的翻譯工作**
1011
Python 發行版本時，也將會將翻譯滾動至新的版本。
1112

1213

13-
在 [Wiki] 中有更多關於參加翻譯、翻譯風格規範、自行編譯文件等說明。
14+
在 Wiki_ 中有更多關於參加翻譯、翻譯風格規範、自行編譯文件等說明。
15+
16+
想問問題、認識翻譯同好，歡迎加入 Telegram 聊天室 t.me/PyDocTW_
1417

15-
想問問題、認識翻譯同好，歡迎加入 Telegram 聊天室 `t.me/PyDocTW<https://t.me/PyDocTW>`_。
18+
.. _Wiki: https://github.com/python-doc-tw/python-docs-zh-tw/wiki
19+
.. _t.me/PyDocTW: https://t.me/PyDocTW
1620

1721

1822
參加翻譯
1923
========
2024

21-
請於 [Transifex] 網站註冊帳號並參加 [python-36-tw] 的翻譯專案。
25+
如何參加翻譯
26+
------------
27+
28+
實際的翻譯即為修改 po 檔，流程遵照標準的 **GitHub Flow**，請 fork 此專案並在您
29+
自己的 fork 裡新增一個 branch，修改 po 檔內容並 commit、push 以後對此專案發出
30+
pull request（記得 base 是此專案的其中一個 branch；目前只有 3.6），至少有一人
31+
審查過翻譯以後，才可以 merge 進入此 repository 中。
32+
33+
在對任何檔案進行貢獻之前，請先在本專案**新增一個 issue**，註明您正在翻譯的頁面
34+
名稱，並將該 issue **assign 給自己**，讓大家知道您正在修改該頁面，以避免多人
35+
同時貢獻同一個檔案的衝突。
36+
37+
編輯 po 檔的方式主要可以分為兩種，以 Transifex 作為工具或是使用其他翻譯工具：
38+
39+
1. 使用 Transifex 作為翻譯工具
40+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
41+
42+
您可以註冊 Transifex 帳號並加入我們的 `Transifex 專案
43+
<https://www.transifex.com/python-tw-doc/python-36-tw>`_，並且在上面
44+
編輯您所要翻譯的頁面，並且在您本機上透過 command line 從此專案的 clone 的
45+
根目錄位置執行以下指令：
46+
47+
.. code-block:: bash
48+
49+
$ ./txpull <po 檔的路徑>
50+
51+
此指令會需要 PyPI 上的 ``transifex-client`` 和 ``poindent``，|gettext|_、
52+
``tac`` 等指令。這個小工具可以幫您把您在 Transifex 上針對特定檔案的翻譯 pull
53+
下來，並且修正換行格式的錯誤。您在使用 txpull 以後就可以 commit 以及 push 了。
54+
55+
.. |gettext| replace:: ``gettext``
56+
.. _gettext: https://www.gnu.org/software/gettext/
57+
58+
2. 使用其他翻譯工具
59+
^^^^^^^^^^^^^^^^^^^
60+
61+
使用 Transifex 並非強迫性，您可以使用其他翻譯工具，如：
62+
63+
- 推薦：`poedit <https://www.poedit.net/>`_
64+
- gted
65+
- gtranslator
66+
- lokalize
67+
- betterpoeditor
68+
- 適當模式底下的 vim 或 emacs
69+
- Vé on Android
70+
- 可能還有更多其他的
71+
72+
編輯完檔案以後，請執行以下指令以確保檔案的換行格式一致（需要安裝
73+
|poindent|_）：
74+
75+
.. |poindent| replace:: ``poindent``
76+
.. _poindent: https://pypi.org/project/poindent/
77+
78+
.. code-block:: bash
79+
80+
$ poindent <po 檔的路徑>
81+
82+
執行完 ``poindent`` 以後即可 commit、push 等。
83+
84+
授權與 License
85+
--------------
2286

23-
[Wiki] 有簡單的 [Transifex 使用教學](https://github.com/python-doc-tw/python-doc-tw/wiki/How-to-translate-%28on-Transifex%29)，並請參考[翻譯手則](https://github.com/python-doc-tw/python-doc-tw/wiki/Translation-guideline)中的原則來翻譯。
87+
以下為 Documentation Contribution Agreement，說明文件貢獻協議，請在貢獻以前
88+
務必詳讀以下內容。（後面有中文翻譯）
2489

25-
<http://docs.python.org.tw/3/> 目前每天會自動更新一次。你也可以點每一頁左側欄的「Update Translation」強迫更新該頁的翻譯。
90+
Documentation Contribution Agreement
91+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2692

93+
NOTE REGARDING THE LICENSE FOR TRANSLATIONS: Python's documentation is
94+
maintained using a global network of volunteers. By posting this
95+
project on Transifex, Github, and other public places, and inviting
96+
you to participate, we are proposing an agreement that you will
97+
provide your improvements to Python's documentation or the translation
98+
of Python's documentation for the PSF's use under the CC0 license
99+
(available at
100+
https://creativecommons.org/publicdomain/zero/1.0/legalcode). In
101+
return, you may publicly claim credit for the portion of the
102+
translation you contributed and if your translation is accepted by the
103+
PSF, you may (but are not required to) submit a patch including an
104+
appropriate annotation in the Misc/ACKS or TRANSLATORS file. Although
105+
nothing in this Documentation Contribution Agreement obligates the PSF
106+
to incorporate your textual contribution, your participation in the
107+
Python community is welcomed and appreciated.
27108

109+
You signify acceptance of this agreement by submitting your work to
110+
the PSF for inclusion in the documentation.
28111

29-
## 授權與 License
112+
中文翻譯
113+
^^^^^^^^
30114

31-
由於翻譯的文字會滾動更新至未來的版本，為了讓這個翻譯專案能長久地維持，每個翻譯者都必須放棄自己翻譯文字的著作權。Python Documentation 原文採用 PSF License 授權（BSD-like），故翻譯完成的文件亦將以相同授權釋出。
115+
（可能有些許偏差，請以上面的原文為標準）
32116

33-
在成為翻譯者時即表示同意上述的授權方式。
117+
請注意此予翻譯專案的授權：Python 的說明文件是以全球的志工社群來維護。透過張貼
118+
此專案在 Transifex、GitHub 以及其他公眾場合，以及邀請您參與，我們向您提出一個
119+
協議：您必須將您對於 Python 說明文件或是 Python 說明文件翻譯的貢獻以 CC0
120+
（請參考 https://creativecommons.org/publicdomain/zero/1.0/legalcode）的方式
121+
授權給 PSF 使用。您可以公開地聲明您所貢獻翻譯的部分，並且如果您的翻譯被 PSF
122+
採用，您可以（但並不須要）送出一個修改，其包含在 Misc/ACKS 或是 TRANSLATORS
123+
檔案裡增加合適的注釋。雖然這個說明文件貢獻協議並沒有說明 PSF 有義務納入您的
124+
文本貢獻，您在 Python 社群的參與是受歡迎且受感激的。
34125

126+
您在對 PSF 送出說明文件貢獻的同時，即表示同意上述的協議。
35127

36128

37-
## 問題回報與討論
129+
問題回報與討論
130+
--------------
38131

39-
對於翻譯有任何問題，請開設一個新的 [Issue](https://github.com/python-doc-tw/python-doc-tw/issues)。討論使用 [Gitter chatroom]。
132+
對於翻譯有任何問題，請開設一個新的 Issue_。討論使用 Telegram_。
40133

134+
.. _Issue: https://github.com/python-doc-tw/python-docs-zh-tw/issues
135+
.. _Telegram: https://t.me/PyDocTW
41136

42-
## Acknowledgement
43137

44-
This translation project is highly influenced by [python-doc-ja]'s translation architecture and workflow (aka a shameless copy). We truly thank their contribution.
138+
Acknowledgement
139+
---------------
45140

46-
[wiki]: https://github.com/python-doc-tw/python-doc-tw/wiki
47-
[Gitter chatroom]: https://gitter.im/python-doc-tw/python-doc-tw
48-
[Transifex]: https://www.transifex.com/
49-
[python-36-tw]: https://www.transifex.com/python-tw-doc/python-36-tw/
50-
[python-doc-ja]: https://github.com/python-doc-ja/python-doc-ja
141+
This translation project is highly influenced by python-doc-ja_ and
142+
python-doc-fr_'s translation architecture and workflow (i.e. a shameless
143+
copy). We truly appreciate their contributions.

0 commit comments

Comments
 (0)