如何为Flask-PluginKit做出贡献

感谢您考虑为Flask-PluginKit做贡献

反馈

报告问题

  • 描述您期望发生的事情。

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

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

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

提交pull request

首先是环境

  • fork repository Flask-PluginKit

  • 克隆Flask-PluginKit，并设置好个人的 git config

  • 使用命令 make dev 安装开发环境依赖的模块

接着是编码

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

  • 编写测试用例和文档。

  • Run the test make dev && make test using the py3.8+ environments respectively.

  • 使用 make dev && make html 生成文档

  • 如果您想翻译文档，步骤如下：

    1. 执行命令 make gettext

    这个操作会将可翻译的消息提取到pot文件中，生成的pot文件将放在 docs/_build/gettext 目录中。

    1. 执行命令 make cn

    在 docs/locale/<LANG>/LC_MESSAGES/ 目录生成或更新po文件，然后就可以翻译不同语言下的po文件了。

    1. 执行命令 make html-cn

    构建生成翻译文档

最后合并请求

  • 提交代码

  • 在GitHub上发起 pull request