如何为 Flask 做出贡献

问题跟踪器的用途是记录 Flask 本身相关的问题和功能需求的，因此请不要使用问题 跟踪器来提问。如果有关于 Flask 使用方面或者你自己代码的方面的问题，请使用下 列途径之一提问：

• Discord chat 上的 频道： https://discord.gg/pallets

• 邮件列表 用于长期或者大型问题讨论。

• 在 Stack Overflow 上提问。提问前请先使用以下方法在 Google 上搜索： site:stackoverflow.com flask {search term, exception message, etc.}

• 在我们的 上提问。

请在报告中包含以下内容：

• 描述你希望发生的事情。

• 如果可能，提供一个 最小的可重现的示例 以帮助我们找到问题。 这也有助于鉴别问题是否也你自己的代码有关。

• 描述实际发生了什么。如果有异常，则应当包含完整的回溯。

• 列出你的 Python 、 Flask 和 Werkzeug 版本。如果可能，检查是否这个问题已 在存储库中修复。

在提交一个 PR 之前，如果没有相关的开放议题，那么建议打开一个新的相关议题讨论 一下。如果你对某个议题感兴趣，而这个议题没有相关联的 PR 也没有指定维护人，那么 你就直接上手吧，不需要征得同意。

提交补丁应当做好以下工作：

• 如果补丁增加或者改动了代码，那么应当包含测试，并确保如果没有补丁，测试就会 失败。

• 在 CHANGES.rst 中增加一个条目，条目的样式与其他条目相同。同时，在相关的 docstring 中包含 .. versionchanged:: 行内变更记录。

• 下载并安装 。

• 配置使用 git 的 username 和 。

• 确保你有一个 GitHub 账号 。

• 点击 按钮将 Flask fork 到你的 GitHub 账户。

• 把主仓库 Clone 到本地。

  $ git clone https://github.com/pallets/flask
  $ cd flask

• 把你的工作作为一个远程分支，用你的用户名替换 {username} ，这样对远程 分支进行了命名，缺省的 Pallets 远程分支名为 “origin” 。

  $ git remote add fork https://github.com/{username}/flask

• 创建一个 virtualenv 。

  Linux/macOSWindows

  $ python3 -m venv env
  $ . env/bin/activate

  > py -3 -m venv env
  

• 升级 pip 和 setuptools 。

• $ pip install -r requirements/dev.txt && pip install -e .

• 创建一个分支来表明你想要处理的议题。如果要提交一个缺陷修复或者文档修正， 请从最后的“ .x ”分支来创建分支。

• 使用你最喜欢的编辑器，修改代码， 。

• 应当包含覆盖你所做的全部修改的测试，并且确保没有补丁则测试失败。详细内容见 下一节。

• 把你的提交推送到 GitHub 上你的分支中，并 创建一个拉取请求 。在拉取请求中 链接类似 fixes #123 的议题。

用 pytest 运行基本的测试套件。

$ pytest

上述测试是针对当前环境的，通常是有效的。当你提交拉取请求时， CI 会运行全部测试。 如果不想浪费时间，那么可以用 tox 运行所有测试。

生成一个报告，确定哪些代码未被测试覆盖，以指明工作的方向。 使用 coverage 运行 pytest 并生成一份报告。

$ pip install coverage
$ coverage run -m pytest
$ coverage html

在浏览器中打开 htmlcov/index.html 并研读报告。

请阅读更多关于 的文档。

使用 Sphinx 构建 docs 文件夹中的文档。

$ cd docs
$ make html

在浏览器中打开 _build/html/index.html 以查看文档。

请阅读更多关于 Sphinx 的内容。