贡献¶
报告一个错误¶
你可以在 deap 的 Github 问题页面上报告一个错误。
获取最新代码¶
你可以使用以下命令检查最新的源代码:
git clone https://github.com/DEAP/deap.git
贡献代码¶
为 deap 贡献的首选方式是在 GitHub 上 fork 主仓库,然后提交一个“拉取请求”(PR):
Fork 项目仓库:点击页面顶部的 ‘Fork’ 按钮。这会在 GitHub 服务器上你的账户下创建代码的副本。
在本地克隆你的分支:
$ git clone git@github.com:YourLogin/deap.git创建一个分支来保存你的更改:
$ git checkout -b my-feature并开始进行更改。永远不要在
master
分支上工作!编辑完成后,执行:
$ git add modified_files $ git commit要在 Git 中记录你的更改,然后将它们推送到 GitHub,请使用:
$ git push -u origin my-feature
最后,访问你fork的deap仓库的网页,点击’Pull request’以提交你的更改供审核。
您也可以在 deap 用户列表上联系我们,地址是 http://groups.google.com/group/deap-users。
编码指南¶
这些约定大部分基于 Python PEP8。
样式指南是关于一致性的。与本样式指南保持一致是重要的。在一个项目中保持一致性更为重要。在一个模块或函数中保持一致性最为重要。
代码布局¶
与 PEP8 相同。
导入¶
文件中的第一个导入是标准库模块,接着是 deap 模块的导入,最后是问题自定义模块的导入。每个导入块之间应该用一个新行分隔。
import system
from deap import base
import mymodule
表达式和语句中的空白¶
与 PEP8 相同。
文档字符串¶
与 PEP8 相同
命名约定¶
模块 : 使用小写约定。
类 : 类名使用 CapWords 约定。
函数 / 过程 : 使用 mixedCase 约定。第一个词应为动词。
变量 : 使用 lower_case_with_underscores 约定。
注释¶
与 PEP8 相同