🤝 贡献指南

Sponsored by n8n

Does your interface have a backend yet? Try n8n

🚀 欢迎贡献者！ 🚀

感谢您对为 Open WebUI 做出贡献的兴趣。本文件旨在指导您完成贡献流程，确保您的贡献能有效提升项目的质量。让我们一起让 Open WebUI 变得更好吧！

💡 贡献方式

想要贡献？太棒了！以下是您可以帮助我们的方式：

🌟 代码贡献指南

我们欢迎代码提交（pull requests）。在提交之前，请确保：

1. 在这里针对您的想法打开讨论。
2. 遵循项目的代码标准，并为新功能添加测试。
3. 根据需要更新文档。
4. 编写清晰详细的提交信息。

🛠 代码PR最佳实践：

1. 原子性PR: 确保您的PR是小型、专注的，并只处理一个目标或任务。这有助于代码审查更容易，并减少引入无关问题的可能性。如果更改范围变得太大，请考虑将其拆分为较小的、逻辑独立的PR。
2. 遵循现有代码习惯: 确保您的代码符合项目的现有编码标准和实践。
3. 避免额外的外部依赖: 在没有事先讨论的情况下，请不要引入额外的外部依赖。
4. 框架无关的方法: 我们致力于保持框架无关的方法。尽可能自己实现功能，避免依赖于外部框架或库。如果对此方法有怀疑或建议，请随时讨论。

感谢您的贡献！🚀

📚 文档与教程

通过改进文档、编写教程或创建关于设置和优化WebUI的指南，帮助我们让 Open WebUI 更加易于访问。

🌐 翻译与国际化

帮助我们使 Open WebUI 被更广泛的受众使用。在本章节中，我们将指导您如何为项目添加新的翻译。

我们使用JSON文件存储翻译内容。您可以在 src/lib/i18n/locales 目录找到已有的翻译文件。每个目录对应某一种语言，例如 en-US 表示美式英语，fr-FR 表示法语（法国）等等。您可以参考 ISO 639语言代码 找到具体语言的代码。

添加新的语言的方法：

• 在 src/lib/i18n/locales 路径中创建一个新的目录，使用适当的语言代码作为其名称。例如，如果您添加的是西班牙语（西班牙）的翻译，则创建一个名为 es-ES 的新目录。
• 复制美式英语的翻译文件（src/lib/i18n/locale 下的 en-US 目录）到新目录，并根据您的语言更新JSON格式的字符串值。请确保保留JSON对象的结构。
• 将语言代码及其对应的标题添加到 src/lib/i18n/locales/languages.json 的语言文件中。

🤔 问题与反馈

有问题或反馈？加入我们的 Discord 社区 或提交一个问题。我们随时为您提供帮助！

🚨 问题报告

发现了什么问题？有了好的想法？查看我们的 问题标签，看看是否已经有人报告或建议。如果没有，欢迎您提出新问题。在报告问题时，请按照我们的问题模板操作。这些模板旨在确保从一开始就提供所有必要的信息，以便我们更高效地解决您的问题。

important

• 遵守模板: 请注意，如果未遵守提供的问题模板或根本未提供请求的信息，您的问题很可能会直接被关闭不再考虑。此做法对于保持问题跟踪的可管理性和完整性至关重要。

• 细节至关重要: 为确保您的问题被理解并能有效解决，请务必提供详细的信息。描述应清晰，包括重现步骤、预期结果和实际结果。缺乏详细信息可能会阻碍我们解决您的问题的能力。

🧭 支持范围

我们注意到，有越来越多的问题与 Open WebUI 本身无关，而是与其运行环境有关，尤其是 Docker 的设置。尽管我们努力支持 Docker 部署，但了解 Docker 的基本知识对于顺畅的使用体验至关重要。

• Docker 部署支持: Open WebUI 支持 Docker 部署。假定您熟悉 Docker 的使用。如需 Docker 入门知识，请参考 官方 Docker 文档。

• 高级配置: 为HTTPS设置反向代理和管理Docker部署需要一些基础知识。网上有许多资源可以学习这些技能。掌握这些知识将极大地提升你使用Open WebUI和类似项目的体验。

🙏 谢谢您！

您的贡献，无论大小，都对Open WebUI有着重要的影响。我们很期待您为项目带来的新内容！

让我们一起努力，为社区创造一个更强大的工具吧。🌟