贡献

欢迎贡献，我们非常感谢！任何帮助都非常有用，我们会永远给予你应有的认可。

你可以通过多种方式做出贡献

贡献类型

报告错误

请在 https://github.com/sknetwork-team/sknetwork/issues 上报告错误。

如果你要报告错误，请包括以下信息：

  • 你的操作系统名称和版本。

  • 任何可能有助于故障排除的本地设置信息。

  • 重现错误的详细步骤。

修复错误

查看 GitHub 问题中的错误。任何标记为“bug”和“需要帮助”的问题都可供任何想要实现的人参与。

实现功能

查看 GitHub 项目。项目中列出的任何内容都是要实现的功能。

你也可以查看 GitHub 问题中的功能。任何标记为“增强”和“需要帮助”的问题都可供任何想要实现的人参与。

编写文档

scikit-network 始终需要更多的文档，无论是作为官方 scikit-network 文档的一部分，还是作为文档字符串，甚至是在博客文章、文章等网络上的文档。

提交反馈

发送反馈的最佳方式是在 https://github.com/sknetwork-team/sknetwork/issues 上提交问题或在 https://github.com/sknetwork-team/scikit-network/discussions 上发起讨论。

如果你要提出一个功能建议

  • 详细说明其工作原理。

  • 尽量缩小范围，以便更易于实现。

  • 请记住，这是一个志愿者驱动的项目，欢迎贡献！:)

开始吧！

准备贡献？以下是设置 sknetwork 用于本地开发的方法。

  1. 在 GitHub 上 fork sknetwork 仓库。

  2. 将你的 fork 克隆到本地。

    $ git clone [email protected]:your_name_here/sknetwork.git

  3. 将你的本地副本安装到 virtualenv 中。假设你已安装了 virtualenvwrapper，以下是设置你的 fork 用于本地开发的方法：

    $ mkvirtualenv sknetwork
$ cd sknetwork/
$ python setup.py develop

  4. 为本地开发创建分支。

    $ git checkout -b name-of-your-feature

    现在你可以在本地进行修改。

  5. 修改完成后，请检查你的更改是否通过 flake8 和测试，包括使用 tox 测试其他 Python 版本。

    $ flake8 sknetwork tests
$ python setup.py test or py.test
$ tox

    要获得 flake8 和 tox，只需将它们 pip 安装到你的 virtualenv 中即可。

  6. 提交你的更改并推送到 GitHub 上你的分支。

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-feature

  7. 通过 GitHub 提交拉取请求。

拉取请求指南

提交拉取请求之前，请确保它符合以下指南：

  1. 拉取请求应包含测试。

  2. 如果拉取请求添加了功能，则应更新文档。将你的新功能放在一个带有文档字符串的函数中，并将该功能添加到 README.rst 中的列表中。

  3. 拉取请求应适用于 Python >= 3.8。

可以在 Wiki 中的“贡献指南”下找到有关编写该软件包代码的更完整指南。

提示

要运行测试的子集

$ py.test tests.test_sknetwork

请随时查看 Wiki。