# RxSwift-CN

**Repository Path**: VenkeFan/RxSwift-CN

## Basic Information

- **Project Name**: RxSwift-CN
- **Description**: :memo: RxSwift文档的中文翻译
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-05-27
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# RxSwift-CN
[RxSwift](https://github.com/ReactiveX/RxSwift)文档的中文翻译版本

|当前RxSwift标的版本|
|-----|
|2.5.0|

## 当前状态
| 原文 | 中文| 翻译人 |
| --- | ---- | ---- |
| [API.md](source/API.md) |[API.md](source-cn/API.md)|[Alan Li](https://github.com/iamlipan)|
| [ComparisonWithOtherLibraries.md](source/ComparisonWithOtherLibraries.md) |[ComparisonWithOtherLibraries.md](source-cn/ComparisonWithOtherLibraries.md)|[zerob13](https://github.com/zerob13)|
| [DesignRationale.md](source/DesignRationale.md) |[DesignRationale.md](source-cn/DesignRationale.md)|[Edison Hsu](https://github.com/Edison-Hsu)|
| [ExampleApp.md](source/ExampleApp.md) |[ExampleApp.md](source-cn/ExampleApp.md)|[Edison Hsu](https://github.com/Edison-Hsu)|
| [Examples.md](source/Examples.md) |[Examples.md](source-cn/Examples.md)|[Edison Hsu](https://github.com/Edison-Hsu)||
| [GettingStarted.md](source/GettingStarted.md) |[GettingStarted.md](source-cn/GettingStarted.md)|[Edison Hsu](https://github.com/Edison-Hsu)|
| [HotAndColdObservables.md](source/HotAndColdObservables.md) |[HotAndColdObservables.md](source-cn/HotAndColdObservables.md)|[Edison Hsu](https://github.com/Edison-Hsu)|
| [Installation.md](source/Installation.md) |[Installation.md](source-cn/Installation.md)|[Edison Hsu](https://github.com/Edison-Hsu)|
| [Linux.md](source/Linux.md) |[Linux.md](source-cn/Linux.md)|[Edison Hsu](https://github.com/Edison-Hsu)|
| [MathBehindRx.md](source/MathBehindRx.md) |[MathBehindRx.md](source-cn/MathBehindRx.md)|[Edison Hsu](https://github.com/Edison-Hsu)|
| [Playgrounds.md](source/Playgrounds.md) |[Playgrounds.md](source-cn/Playgrounds.md)|[Edison Hsu](https://github.com/Edison-Hsu)|
| [Schedulers.md](source/Schedulers.md) |[Schedulers.md](source-cn/Schedulers.md) |[Edison Hsu](https://github.com/Edison-Hsu)|
| [Subjects.md](source/Subjects.md) |[Subjects.md](source-cn/Subjects.md)|[Edison Hsu](https://github.com/Edison-Hsu)|
| [Tips.md](source/Tips.md) |[Tips.md](source-cn/Tips.md)|[Edison Hsu](https://github.com/Edison-Hsu)|
| [Units.md](source/Units.md) | [Units.md](source-cn/Units.md) | [Edison Hsu](https://github.com/Edison-Hsu) |
| [Warnings.md](source/Warnings.md) |[Warnings.md](source/Warnings.md) |[Edison Hsu](https://github.com/Edison-Hsu)|
| [Why.md](source/Why.md) |[Why.md](source-cn/Why.md)|[Edison Hsu](https://github.com/Edison-Hsu)|

## 如何参与翻译流程
1. 查看上表和pull request 中还空缺的位置（例如API.md中翻译人是空白或pr中未有人认领）
2. 对该项目提一个 pull request，将相应位置填入自己的信息（可附带一个超链接）
3. 等待merge通过
4. 通过后即可在本页中看到自己的信息，这就确认这篇文章被您认领
5. 开始翻译
6. 翻译完再次提交 pull request
7. 通过初步校验后完成翻译
8. 当有文章完成翻译后开始校验环节，同样走一次1-7的流程
9. 完成翻译或校验后可提 pull request 增加贡献人名单

## 翻译中的几个约定
1. 中文文档统一存放在`source-cn`文件夹中
2. 文件名称与原文文件名称保持一致
3. 专有名词或常用名词可不翻译，例如`Observer`，尽量使用原词`Observer`而不用翻译成中文`观察者`。可保持文章的专业性，减少翻译污染
4. 当认领成功后。我们预留一周时间翻译，如果超过一周时间则会清除名额，再次进行认领
5. 当一个版本完成后会使用gitbook编译成电子书，方便阅读
5. 有其他约定可通过issue或者 pull request 在此 体现

## 贡献人
TBD