贡献
拉取请求
要做出贡献,请克隆存储库,进行更改,提交并推送到克隆,并提交拉取请求。
注意:如果您不是此存储库的贡献者,您需要在推送更改之前分叉和克隆存储库。有关更多信息,请查看GitHub文档中的Contributing to Projects。
- 如果您要添加大量代码,请考虑将其作为扩展。
- 不要在同一PR中添加多个不相关的内容。
- PR应该针对
dev
分支。 - 通过运行测试,确保您的更改不会破坏任何内容。
- 不要在不改变其所作所为的情况下提交PR,只需采取现有行并重新格式化它们。
- 如果您正在提交错误修复程序,我一定有办法重现错误。
- 不要使用克隆
master
分支或main
分支来制作PR-创建一个分支和PR。
有一个用于webui开发的不和谐通道(点击展开)。如果您想实时谈论PR,请加入。如果您没有参与开发,请不要加入。(这只是为了发展,而不是为了技术支持。开发不和谐 )
如果您正在更改已使用的库或安装脚本,则必须验证它们才能从头开始在默认Windows安装上工作。如果您无法测试它是否工作(由于您的操作系统或其他原因),请勿进行这些更改(明确防止在Windows上由if
或其他东西执行的更改可能除外)。
代码样式
我们使用linters来强制执行python和javascript的样式。如果您的PR没有通过检查,我会要求您修复代码,直到linter不再抱怨。
以下是在本地使用linters的方法:
Python
安装:pip install ruff
运行:ruff .
(或python -mruff .
)
JavaScript
安装:在您的系统上安装npm。
运行:npx eslint .
Quirks
webui.user.bat
永远不会被编辑requirements_versions.txt
适用于python 3.10.6requirements.txt
适用于在colabs上运行的人,以及不使用python 3.7的东西
Gradio
Gradio在某个时候想把这部分添加到贡献部分,这是我当时没有的项目,所以现在就在这里。
对于Gradio,请查看文档以贡献:Gradio有问题或功能请求吗?在github上打开问题/功能请求以获得支持:https://github.com/gradio-app/gradio/issues