CONTRIBUTING.md 1.9 KB
Newer Older
W
wizardforcel 已提交
1 2
# 贡献指南

3
> 请您勇敢地去翻译和改进翻译。虽然我们追求卓越,但我们并不要求您做到十全十美,因此请不要担心因为翻译上犯错——在大部分情况下,我们的服务器已经记录所有的翻译,因此您不必担心会因为您的失误遭到无法挽回的破坏。(改编自维基百科)
W
wizardforcel 已提交
4 5 6

可能有用的链接:

7 8
+   [最新 英文文档](https://pytorch.org/docs/)
+   [最新 英文教程](https://pytorch.org/tutorials/)
片刻小哥哥's avatar
片刻小哥哥 已提交
9
+   [1.0 中文教程 & 文档](https://pytorch.apachecn.org/docs/1.0/)
W
wizardforcel 已提交
10
+   [0.3 中文教程 & 文档](https://pytorch.apachecn.org/docs/0.3/)
飞龙 已提交
11 12 13
+   [公式问题如何解决](https://github.com/apachecn/pytorch-doc-zh/issues/360)
+   [模版文章](https://github.com/apachecn/pytorch-doc-zh/blob/master/docs/1.0/chatbot_tutorial.md)
+   [知乎中文专栏](https://zhuanlan.zhihu.com/c_1141766027527385088)
W
wizardforcel 已提交
14 15 16 17 18

## 流程

### 一、认领

片刻小哥哥's avatar
片刻小哥哥 已提交
19
首先查看[整体进度](https://github.com/apachecn/pytorch-doc-zh/issues/487),确认没有人认领了你想认领的章节。
片刻小哥哥's avatar
片刻小哥哥 已提交
20

21
然后回复 ISSUE,注明“章节 + QQ 号”(一定要留 QQ)。
W
wizardforcel 已提交
22

飞龙 已提交
23 24
需要取消认领的人也在此留言,两个月未完成默认放弃任务。

W
wizardforcel 已提交
25
### 二、校对
W
wizardforcel 已提交
26

W
wizardforcel 已提交
27
需要校对:
W
wizardforcel 已提交
28

W
wizardforcel 已提交
29 30 31
1.  语法
2.  术语使用
3.  文档格式
W
wizardforcel 已提交
32

33
Note: 可以合理利用翻译引擎(例如[谷歌](https://translate.google.cn),但一定要把它变得可读!
片刻小哥哥's avatar
片刻小哥哥 已提交
34

W
wizardforcel 已提交
35
如果觉得现有翻译不好,重新翻译也是可以的。
W
wizardforcel 已提交
36

飞龙 已提交
37 38
图片存放在`docs/<version>/img`目录下,记得文章也改为相对路径。

W
wizardforcel 已提交
39 40
### 三、提交

飞龙 已提交
41
**提交的时候不要改动文件名称,即使它跟章节标题不一样也不要改,因为文件名和原文的链接是对应的!!!**
W
wizardforcel 已提交
42

W
wizardforcel 已提交
43
+   `fork` Github 项目
片刻小哥哥's avatar
片刻小哥哥 已提交
44
+   将译文放在`docs/1.4`文件夹下
W
wizardforcel 已提交
45 46 47
+   `push`
+   `pull request`

片刻小哥哥's avatar
片刻小哥哥 已提交
48
请见 [Github 入门指南](https://github.com/apachecn/kaggle/blob/master/docs/GitHub)