🤝 贡献

赞助商n8n

您的界面有后端了吗？试试 n8n

🚀 欢迎，贡献者们！ 🚀

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

💡 贡献

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

🌟 代码贡献指南

我们欢迎拉取请求（Pull Request）。在提交之前，请先

1. 在此处开启关于您想法的讨论。
2. 遵循项目的编码标准，并为新功能包含测试。
3. 必要时更新文档。
4. 编写清晰、描述性的提交信息（commit messages）。

🛠 代码 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 的 languages 文件中。

🤔 问题 & 反馈

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

🚨 报告问题

注意到有什么不对劲？有想法？查看我们的 问题（Issues）标签页，看看是否已经被报告或建议过。如果没有，请随时提交一个新问题。报告问题时，请遵循我们的问题模板。这些模板旨在确保您从一开始就提供所有必需的详细信息，以便我们更有效地解决您的问题。

重要

• 模板合规性：请注意，未能遵循提供的问题模板，或根本未提供所需信息，很可能导致您的问题在未作进一步考虑的情况下被关闭。这种方法对于维护问题跟踪的可管理性和完整性至关重要。

• 细节是关键：为了确保您的问题被理解并能得到有效解决，务必包含全面的详细信息。描述应清晰，包括重现步骤、预期结果和实际结果。缺乏足够的细节可能会阻碍我们解决您的问题。

🧭 支持范围

我们注意到，与 Open WebUI 直接相关的问题有所增加，但更多是关于其运行环境，尤其是 Docker 设置的问题。虽然我们努力支持 Docker 部署，但了解 Docker 基础知识对于流畅体验至关重要。

• Docker 部署支持：Open WebUI 支持 Docker 部署。假定您熟悉 Docker。关于 Docker 基础知识，请参阅官方 Docker 文档。

• 高级配置：设置 HTTPS 反向代理和管理 Docker 部署需要基础知识。有大量的在线资源可供学习这些技能。确保您具备这些知识将大大提升您使用 Open WebUI 及类似项目的体验。

🙏 感谢您！

您的贡献，无论大小，都对 Open WebUI 产生重大影响。我们期待您为项目带来什么！

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