贡献

感谢您的关注!Sanic一直在寻找贡献者。如果您不愿意编写代码,那么非常感谢您向源文件添加docstring。

安装

为了在SANIC上开发(主要是为了运行测试),强烈建议从源代码安装。

因此,假设您已经克隆了repo,并且在已设置虚拟环境的工作目录中,然后运行:

pip3 install -e '.[dev]'

依赖关系更改

Sanic 不使用 requirements*.txt 用于管理与之相关的任何依赖项的文件,以简化管理依赖项所需的工作。请确保您已阅读并理解文档中解释此方法的以下部分 sanic 管理中的依赖项 setup.py 文件。

相关性类型

使用

安装

要求

SANIC运行所需的最小裸依赖项

pip3 install -e .

测试要求/附加要求 [“测试”]

运行单元测试所需的依赖项 sanic

pip3 install -e '.[test]'

extras_require['dev']

额外的发展要求,以增加贡献

pip3 install -e '.[dev]'

extras_require['docs']

建立和增强SANIC文档所需的依赖性

pip3 install -e '.[docs]'

运行试验

为了进行健康检查,建议使用类似于毒物的方法:

tox

看,就这么简单!

拉请求!

所以拉请求审批规则非常简单:

  • 所有请求必须通过单元测试

  • 所有拉取请求必须由项目上至少一个当前合作者审查和批准。

  • 所有请求必须通过flake8检查

  • 如果决定从任何公共接口中删除/更改任何内容,则应附带一条取消预测消息。

  • 如果您实现了一个新特性,您应该至少有一个单元测试伴随它。

文档

SANIC的文档是使用 sphinx . 指南以降价形式书写,可在 docs 文件夹,而模块引用是使用 sphinx-apidoc .

要从头生成文档:

sphinx-apidoc -fo docs/_api/ sanic
sphinx-build -b html docs docs/_build

HTML文档将在 docs/_build 文件夹。

警告

Sanic 的主要目标之一就是速度。如果代码降低了SANIC的性能,但在可用性、安全性或功能方面没有显著的提高,则不能合并。请不要让这吓到你!如果您对某个想法有任何顾虑,请打开一个问题进行讨论并提供帮助。