我们非常欢迎大家来贡献代码,我们会向贡献者致以最诚挚的敬意。
一般可以通过在Github上提交Pull Request来贡献代码。
-
代码规范 遵从pep8,pythonic。
-
代码格式 提交前 请按 pep8 进行格式化。
-
必须添加测试! - 如果没有测试(单元测试、集成测试都可以),那么提交的补丁是不会通过的。
-
记得更新文档 - 保证
README.md以及其他相关文档及时更新,和代码的变更保持一致性。 -
版本号及周期 - 由发布的时间决定,每个模块下都有不同的版本号文件夹,组成格式
v + 发布日期。 -
创建feature分支 - 最好不要从你的master分支提交 pull request。
-
一个feature提交一个pull请求 - 如果你的代码变更了多个操作,那就提交多个pull请求吧。
-
清晰的commit历史 - 保证你的pull请求的每次commit操作都是有意义的。如果你开发中需要执行多次的即时commit操作,那么请把它们放到一起再提交pull请求。
py.test