Skip to content

拉取请求

要进行贡献，首先克隆存储库，进行更改，提交并推送到您的克隆，并提交拉取请求。

注意 如果您不是该存储库的贡献者，在推送更改之前，您需要先fork并克隆存储库。有关更多信息，请查阅GitHub文档中的贡献项目。

  • 如果您要添加大量代码，请考虑将其制作为扩展。
  • 这样，您将能够在将来进行更改而无需经过我的批准
  • 我也不必研究您的代码
  • 如果您的扩展需要对存储库进行一些更改（例如添加API或回调），欢迎添加此更改，并且其他开发人员也会受益
  • 不要在同一个拉取请求中添加多个不相关的内容。
  • 拉取请求应该针对dev分支。
  • 通过运行测试确保您的更改不会破坏任何内容。
  • 不要提交只是重新格式化现有行而不改变其功能的拉取请求。
  • 如果您提交的是错误修复，必须有一种方法让我重现该错误。
  • 不要使用您的克隆的master或main分支进行拉取请求 - 创建一个分支并进行拉取请求。
有一个用于WebUI开发的Discord频道（点击展开）。如果您想实时讨论拉取请求，请加入。如果您不参与开发，请不要加入。
这是一个仅用于开发的Discord频道，不提供技术支持。
[开发Discord](https://discord.gg/WG2nzq3YEH)

如果您对使用的库或安装脚本进行更改，必须验证它们在默认的Windows安装上能够正常工作。如果您无法测试其是否正常工作（由于您的操作系统或其他原因），请不要进行这些更改（除非明确通过if或其他方式防止在Windows上执行的更改）。

代码风格

我们使用代码检查工具来强制执行Python和JavaScript的代码风格。如果您提交的拉取请求未通过检查，我将要求您修复代码，直到代码检查工具不再报错。

以下是如何在本地使用代码检查工具：

Python

安装：pip install ruff

运行：ruff .（或python -mruff .）

JavaScript

安装：在您的系统上安装npm。

运行：npx eslint .

特殊情况

  • webui.user.bat 永远不要编辑
  • requirements_versions.txt 是为了 Python 3.10.6
  • requirements.txt 是为了在 Colab 等使用 Python 3.7 的人

Gradio

Gradio 在某个时候想要在贡献部分添加这个部分来推销他们的项目，但当时我没有这个部分，所以现在在这里。

对于 Gradio，请查看 文档 进行贡献： 对于 Gradio 的问题或功能请求，请在 GitHub 上打开一个问题/功能请求以获取支持：https://github.com/gradio-app/gradio/issues