🤝 贡献

Sponsored by Open WebUI

The top banner spot is reserved for Emerald+ Enterprise sponsors

🚀 欢迎，贡献者们！ 🚀

我们非常感谢您对为 Open WebUI 做贡献的兴趣。本文档将指导您完成整个过程，确保您的贡献有效地增强项目。让我们一起让 Open WebUI 变得更好！

💡 贡献

想要贡献？太好了！以下是您可以提供帮助的方式：

🌟 代码贡献指南

我们欢迎拉取请求。在提交之前，请：

1. 在这里开启关于您想法的讨论。
2. 遵循项目的编码标准并为新功能包含测试。
3. 根据需要更新文档。
4. 编写清晰、描述性的提交消息。

🛠 代码 PR 最佳实践：

1. 原子化 PR：确保您的 PR 小而专注，处理单一目标或任务。这有助于更容易的代码审查并限制引入无关问题的机会。如果更改范围变得太大，考虑将其分解为较小的、逻辑上独立的 PR。
2. 遵循现有代码约定：确保您的代码与项目现有的编码标准和实践保持一致。
3. 避免额外的外部依赖：在没有事先讨论的情况下，不要包含额外的外部依赖项。
4. 框架无关方法：我们旨在保持框架无关。尽可能自己实现功能，而不是依赖外部框架或库。如果您对这种方法有疑问或建议，请随时讨论。

感谢您的贡献！🚀

📚 文档和教程

通过改进文档、编写教程或创建设置和优化 Web UI 的指南，帮助我们使 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 产生重大影响。我们很兴奋看到您为项目带来什么！

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