Contributing

感谢您的贡献！

Bug

在GitHub中新建 Issue：

• 描述实际发生的事情，如果可能，请提供完整的异常堆栈。

• 如果可能，请提供一个最小、完整、可验证的示例，这也有助于检查问题是否与你自己的代码有关。

• 列出你的Python、Flask、sapic版本、配置，如果可能，检查新版本是否解决。

  ps：打印配置（SecretKey和Redis地址、密码可用星号代替）

  cd /path/to/sapic/src
  python config.py

Feature

同样是在GitHub中新建 Issue，提出功能需求，描述下其具体要求。 非常欢迎提交PR以直接完成您的功能。

Pull Request

感谢提交代码，可按以下方式启动项目：

首先是环境

• Fork sapic

• 检出/克隆 sapic ，并设置好: git config

  如果您不是最新fork，需先同步最新代码，参考官方文档：Syncing a fork

  请尽量在dev分支编写代码。

• 基础环境与安装过程参照 sapic文档

接着是编码

• 编写代码，请尽量遵守 PEP8规范。

• 如果可能，编写测试用例，建议的吆。

• 如果可能，使用py3.8+运行测试（位于src）: make test

• 如果可能，请编写或更新对应文档，位于docs下，构建文档命令(py3)：

  cd /path/to/sapic/docs
  python3 -m pip install -r ../requirements/docs.txt
  make html

最后合并请求

• 提交代码

• 在GitHub上发起合并到dev分支的pull request

钩子扩展

如果您开发了一个钩子扩展，欢迎提交到Awesome for sapic