[toc]
# 欢迎加入易函数，参与贡献：提意见、Issue与文档
易函数是开源的、免费的软件，这意味着任何人都可以为其开发和进步贡献力量。易函数的项目源代码目前同时托管在 github（主库）和 gitee（国内）平台上，两个平台的仓库保持即时的同步，代码贡献统一使用github主库。我们非常欢迎有更多的朋友加入到易函数的开发中来，你为易函数所做出的任何贡献都将会被记录到易函数的史册中。
贡献代码请提交到github主库 码云仓库仅作为镜像
github (主库) :[https://github.com/duolabmeng6/pyefun](https://github.com/duolabmeng6/pyefun)
码云 :[https://gitee.com/duolabmeng666/pyefun](https://gitee.com/duolabmeng666/pyefun)
qq群 : 1017240979
# 参与开源
## 参与贡献
易函数代码：参与易函数功能开发、单元测试、ISSUE提交、反馈建议等等，[https://github.com/duolabmeng6/pyefun](https://github.com/duolabmeng6/pyefun)
开发文档：参与WIKI文档的撰写，便于更多的人了解、热爱并加入易函数的开发。
## 贡献流程
首先fork一份仓库代码到自己的版本库中；
在自己的版本库中新建开发分支并对代码做修改，随后提交修改到自己的版本库；
在自己的版本库中创建一个pull request，源分支选择自己的开发分支，目标分支选择主库的master分支：[https://help.github.com/en/articles/creating-a-pull-request](https://help.github.com/en/articles/creating-a-pull-request)
提交pull request请求，随后等待由项目的开发作者对提交内容做审核，审核通过之后你将成为易函数的成员之一；
恭喜你，你的名字将永久地载入到易函数源代码的贡献列表中；
## 协作约定
1. 函数名**必须**使用直观易用的**中文命名**。请参考易语言的支持库命名，精易模块、火山开发平台的中文函数命名方式
2. 注释**必须**包括**使用方法**，**代码示例**，**注意事项**，如果逻辑复杂的程序部分需要阐述实现思路
3. **必须**编写**测试用例**。如此运行单个用例：`$ python -m unittest pyefun.regexpUtil_test`
4. 请保持 Windows、Linux 的兼容性。如果是 Windows 的专有函数不要引入公共库`pyefun/__init__.py`中，可参考`pyefun/asyncPoolGevent`、`pyefun/javscript`的方法封装，使用时单独引入即可
5. 贡献代码时**务必**检查代码是否运行正常。
请通过github贡献代码。或者通过提交 issues 的方式贡献代码亦可，贡献代码方式多种多样。
# 贡献代码
# 贡献方式
1. 如果实在不会操作github 将代码发送到 issues 中 https://gitee.com/duolabmeng666/pyefun/issue
2. 进入 pyefun的qq群传到群共享或者将代码变更发给群主
3. 正常的 git 贡献代码流程 （如果你能使用 github 贡献就github ）如果没有条件使用github，码云贡献代码也没有问题的
接下来我们来讲解一下正常的贡献流程 以码云作为代码贡献的例子
正常来讲我应该以github来讲解 但是国内的网络环境原因 这里易 码云的贡献代码流程来讲解
# 1.fork 项目到自己仓库
码云 pyefun 仓库 https://gitee.com/duolabmeng666/pyefun
这里大家注册好码云账户以后就可以 fork了 将代码复制到自己的代码仓库中
这边我的地址是 `https://gitee.com/duolabmengtest/pyefun.git`
将代码用git的工具克隆下来
# 2. 将封装好的代码放到放到这个目录下面然后提交并且推送
# 3. 推送完成以后 提交合并贡献代码
这里推送了以后看到自己的仓库呢就有了修改记录了
# 4. 将代码贡献至pyefun
# 5. 完成后等待 pyefun 的仓库管理员审核你的代码 代码有问题将会合并到pyeufn中
# 感谢您对国内中文编程事业的热爱和贡献
# 帮助信息
* 如果你不知道如何封装可以参考组件目录下已经封装好的组件进行参考 https://gitee.com/duolabmeng666/pyefun/tree/master/pyefun/wxefun
* 如果你有能力使用github贡献代码，请使用github贡献代码
* 封装过程中遇到任何问题都可以在pyefun的qq群中提问 qq群 : 1017240979
