61 lines
3.9 KiB
Markdown
61 lines
3.9 KiB
Markdown
## 第三方贡献说明
|
||
|
||
|
||
- 首先感谢大家对于PaddleOCR的支持，我们也希望大家共同建设，共同分享，形成良好的开源社区氛围:)
|
||
- 如果您也有意愿贡献，可以快速查看[贡献说明](#贡献说明)：
|
||
|
||
## 一、近期更新（截至2020.11.5）
|
||
|
||
|
||
- 非常感谢 [zhangxin](https://github.com/ZhangXinNan)([Blog](https://blog.csdn.net/sdlypyzq)) 贡献新的可视化方式、添加.gitgnore、处理手动设置PYTHONPATH环境变量的问题([#210](https://github.com/PaddlePaddle/PaddleOCR/pull/210))
|
||
- 非常感谢 [lyl120117](https://github.com/lyl120117) 贡献打印网络结构的代码([#304](https://github.com/PaddlePaddle/PaddleOCR/pull/304))
|
||
- 非常感谢 [BeyondYourself](https://github.com/BeyondYourself) 给PaddleOCR提了很多非常棒的建议，并简化了PaddleOCR的部分代码风格([so many commits)](https://github.com/PaddlePaddle/PaddleOCR/commits?author=BeyondYourself)。
|
||
|
||
### 2、新增需求类
|
||
- 非常感谢 [xiangyubo](https://github.com/xiangyubo) 贡献手写中文OCR数据集([#321](https://github.com/PaddlePaddle/PaddleOCR/pull/321))
|
||
- 非常感谢 [Mejans](https://github.com/Mejans) 给PaddleOCR增加新语言奥克西坦语Occitan的字典和语料([#954](https://github.com/PaddlePaddle/PaddleOCR/pull/954))。
|
||
|
||
### 3、新增功能类
|
||
- 非常感谢 [authorfu](https://github.com/authorfu) 贡献Android([#340](https://github.com/PaddlePaddle/PaddleOCR/pull/340))和[xiadeye](https://github.com/xiadeye) 贡献IOS的demo代码([#325](https://github.com/PaddlePaddle/PaddleOCR/pull/325))
|
||
- 非常感谢 [tangmq](https://gitee.com/tangmq) 给PaddleOCR增加Docker化部署服务，支持快速发布可调用的Restful API服务([#507](https://github.com/PaddlePaddle/PaddleOCR/pull/507))。
|
||
- 非常感谢 [lijinhan](https://github.com/lijinhan) 给PaddleOCR增加java SpringBoot 调用OCR Hubserving接口完成对OCR服务化部署的使用([#1027](https://github.com/PaddlePaddle/PaddleOCR/pull/1027))。
|
||
|
||
|
||
<a name="贡献说明"></a>
|
||
## 二、贡献说明
|
||
### 1、修复建议类
|
||
- 如果是bug改动和修复，直接提在官方代码对应位置修改，PR提交，review后合入即可。
|
||
|
||
|
||
### 2、新增需求类
|
||
- 如果目前提供的功能不能满足需求，可以在新需求中增加，注明【需求】xxx，可以提到[新需求](./requests.md)里面。
|
||
|
||
### 3、新增功能类
|
||
|
||
- 新增功能也可以在本文件夹中新建文件夹，按照功能命名，文件夹内需包含完整代码和readme文档，在文档中描述清楚具体如何使用（也可以在个人repo中完成，通过新增requirements文件，增加一行 `paddleocr` 可以通过usedby 收录）
|
||
- 新增部署方式支持，可以在本文件夹新增
|
||
- 新增多种编程语言支持功能，可以在本文件夹新增
|
||
|
||
|
||
## 三、代码要求
|
||
- **文档、文档、文档**，重要的事情说三遍
|
||
- 简单高效，直观明了，功能完善，没有bug
|
||
- 提交之前需要使用 pre-commit 工具来自动检查一些基本事宜（如每个文件只有一个 EOL，Git 中不要添加大文件等）。pre-commit测试是 Travis-CI 中单元测试的一部分，首先安装并在当前目录运行它：
|
||
|
||
```
|
||
pip install pre-commit
|
||
pre-commit install
|
||
```
|
||
|
||
- 目前默认使用 clang-format 来调整 C/C++ 源代码格式，请确保 clang-format 版本在 3.8 以上。注：通过pip install pre-commit和conda install -c conda-forge pre-commit安装的yapf稍有不同的，Paddle 开发人员使用的是pip install pre-commit。
|
||
|
||
|
||
|
||
## 四、联系我们
|
||
- PR之前如果有任何的不确定，欢迎先通过issue或者微信群联系我们，提前沟通pr位置，减少comment和反复修改。
|
||
|
||
|
||
## 五、致谢与后续
|
||
- 合入代码之后，首页README末尾新增感谢贡献，默认链接为github名字及主页，如果有需要更换主页，也可以联系我们
|
||
- 新增重要功能类，会在用户群广而告之，享受开源社区荣誉时刻。
|