CONTRIBUTING.md

# 贡献指南

如果您要参与贡献，让本项目翻译得更好，更好的为中国人提供服务，您需要看本贡献指南。

Termux-document 只有一个需要翻译的文档，原文档在 Termux 运行 `man termux` 查看。

Termux-document 需要翻译的文档名称叫做 Termux User Document（Termux 用户文档），文档翻译难度高，我们使用了人机混合翻译方式，不准确性会降低。

## 人机混合翻译

人机混合翻译是我们定义的一个术语，首先使用多个机器翻译平台（我们使用到了腾讯翻译君、搜狗翻译、Google 翻译、百度翻译。一般情况下我们不会全部去这些翻译平台得到翻译结果，我们会优先使用 Google 翻译，如果符合最佳的标准，则不会再使用其他翻译平台。翻译平台使用优先级：Google 翻译 > 搜狗翻译 > 腾讯翻译 > 百度翻译）翻译出结果（通常是一句一句的翻译），再进行人工评估，选出最佳的翻译结果（这里的最佳指最容易理解，没有病句，没有歧义等）。

### 特殊情况

#### 所有机器翻译平台翻译的结果一样

如果所有机器翻译平台翻译的结果都是一样的，那么我们还是会进行评估，如果不怎么好理解或者有病句或者有歧义等，我们会通过人工翻译（人工翻译完全是由我们自己完成，不依赖人工翻译平台）把翻译结果进一步加工，达到最佳的翻译结果的标准。

## 参与贡献

您如果要参与贡献，我们推荐您使用人机混合翻译方式。您也需要看下面的 Commit message 编写格式。

您假若要创建一个 PR（Pull Requests），您不需要在我们所在的所有开源平台（分别是 [Github](https://github.com/)、[Gitee](https://gitee.com/)、[CodeChina](https://codechina.csdn.net/)）都创建一个 PR，您只需要在其中一个开源平台创建 PR 就可以了，我们有解决方案。

## Commit message 编写格式

从 2020 年 12 月 14 日开始，我们开始规定 Commit message 编写格式。每个人的 Commit message 编写得格式都不一样，会看起来很乱，不方便快速浏览。

我们在规定 Commit message 编写格式时，参照了[这篇文章](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html)。

每次提交，Commit message 都包括两个部分：Header、Body。

```
<type>: <subject> // Header 部分
// 空一行
<body> // Body 部分
// 空一行
<footer> // Footer 部分
```

所有部分是必需的。

不管是哪一个部分，任何一行都不得超过 100 个字符。这是为了避免自动换行影响美观。

### Header 部分

Header 部分只有一行，包括两个字段，两个字段都是必须有的：`type`、`subject`。

#### type

`type` 用于说明 commit 的类别，我们只允许使用下面3个标识。

```
tdocs: 翻译的文档（translate docs）
docs: 非翻译的文档（如 README.md）
style: 格式（不更改内容，更改了格式）
```

您的 Commit 的类别可以有多个，请用英文逗号（,）分割，例如：`tdocs,docs`。全部类别都有的话，请使用 `*`。

#### subject

`subject` 是 commit 目的的简短描述，不超过50个字符。

有两点要注意：

* 结尾不加中文句号（。）或英文句号（.）
* 不能出现颜文字

### Body 部分

Body 部分是对本次 commit 的详细描述，可以分成多行。下面是一个范例。

```
如果有必要，您可以编写此部分。此部分提供比 Header 部分的 subject 字段更详细的说明，字符数量要比 Header 部分的 subject 字段更多。不要超过 100 个字符。
// 如果有编写上面的部分，空一行继续接下来的段落。如果没有请直接编写
// Body 部分主要内容
```

注意：应该说明文档变动的动机，以及与以前的对比。

欢迎您为 termux-document 做出贡献！