CONTRIBUTING.md · liuhongyu/sapic - Gitee.com

forked from staugur/sapic

加入 Gitee

与超过 1200万开发者一起发现、参与优秀开源项目，私有仓库也完全免费：）

克隆/下载

CONTRIBUTING.md 1.95 KB

Contributing
============

感谢您的贡献！

Bug
---

在GitHub中新建 [Issue](https://github.com/sapicd/sapic/issues/new)：

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

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

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

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

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

Feature
-------

同样是在GitHub中新建 [Issue](https://github.com/sapicd/sapic/issues/new)，提出功能需求，描述下其具体要求。
非常欢迎提交PR以直接完成您的功能。

Pull Request
------------

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

**首先是环境**

- Fork [sapic](https://github.com/sapicd/sapic)

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

如果您不是最新fork，需先同步最新代码，参考官方文档：[Syncing a fork](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork)

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

- 基础环境与安装过程参照 [sapic文档](https://sapic.rtfd.vip/install.html)

**接着是编码**

- 编写代码，请尽量遵守 [PEP8规范](https://www.python.org/dev/peps/pep-0008/)。

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

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

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

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

**最后合并请求**

- 提交代码

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

钩子扩展
---------

如果您开发了一个钩子扩展，欢迎提交到[Awesome for sapic](https://github.com/sapicd/awesome)

一键复制编辑原始数据按行查看历史

提交于 2023-01-10 10:12 . Update peripheral & dockerfile(close #28)

Contributing
============

感谢您的贡献！

Bug
---

在GitHub中新建 [Issue](https://github.com/sapicd/sapic/issues/new)：

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

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

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

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

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

Feature
-------

同样是在GitHub中新建 [Issue](https://github.com/sapicd/sapic/issues/new)，提出功能需求，描述下其具体要求。
非常欢迎提交PR以直接完成您的功能。

Pull Request
------------

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

**首先是环境**

- Fork [sapic](https://github.com/sapicd/sapic)

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

  如果您不是最新fork，需先同步最新代码，参考官方文档：[Syncing a fork](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork)

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

- 基础环境与安装过程参照 [sapic文档](https://sapic.rtfd.vip/install.html)

**接着是编码**

- 编写代码，请尽量遵守 [PEP8规范](https://www.python.org/dev/peps/pep-0008/)。

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

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

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

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

**最后合并请求**

- 提交代码

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

钩子扩展
---------

如果您开发了一个钩子扩展，欢迎提交到[Awesome for sapic](https://github.com/sapicd/awesome)

马建仓 AI 助手

尝试更多

代码解读

代码找茬

代码优化

Python

1

https://gitee.com/liuhongyu123/picbed.git

git@gitee.com:liuhongyu123/picbed.git

liuhongyu123

picbed

sapic

master