🤝 贡献

Sponsored by Open WebUI Pipelines

Pipelines: Versatile, UI-Agnostic OpenAI-Compatible Plugin Framework

🚀 欢迎，贡献者们！ 🚀

感谢您对 Open WebUI 的关注与支持。本文档将引导您完成贡献流程，确保您的贡献能够有效提升项目质量。让我们携手共同打造更出色的 Open WebUI！

💡 如何贡献

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

🌟 代码贡献指南

我们非常欢迎拉取请求（Pull Requests）。在提交之前，请注意以下几点：

1. 在此处发起讨论，分享您的想法。
2. 遵循项目的编码标准，并为新功能编写测试。
3. 根据需要更新文档。
4. 编写清晰、描述性的提交信息。

🛠 拉取请求的最佳实践：

1. 原子化拉取请求：确保每个拉取请求小而精，专注于单一目标或任务。这有助于简化代码审查，并减少引入无关问题的风险。如果变更范围过大，考虑将其拆分为多个逻辑独立的小拉取请求。
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 的新目录。
• 将美式英语翻译文件（来自 en-US 目录中的 src/lib/i18n/locales）复制到此新目录中，并根据您的语言更新 JSON 格式的字符串值。请确保保留 JSON 对象的结构。
• 在 src/lib/i18n/locales/languages.json 文件中添加语言代码及其相应的标题。

🤔 问题与反馈

有问题或反馈？加入我们的 Discord 社区，或打开一个 issue。我们在这里为您服务！

🚨 提交问题

发现异常？有新的想法？请先查看我们的 Issues 标签，看看是否已有相关报告或建议。如果没有，请随时提交一个新的 issue。在提交问题时，请遵循我们的模板。这些模板旨在确保从一开始就提供所有必要的细节，以便我们更高效地解决您的问题。

important

• 模板合规性：请注意，未遵循提供的问题模板或未提供所需信息的问题可能会被直接关闭，不再进一步处理。这一做法对于维护问题跟踪的可管理性和完整性至关重要。

• 细节决定成败：为了确保您的问题得到理解和有效解决，必须提供详尽的信息。描述应清晰明了，包括重现步骤、预期结果和实际结果。缺乏足够的细节可能会影响我们解决问题的能力。

🧭 支持范围

我们注意到越来越多的问题并非直接与 Open WebUI 相关，而是与其运行环境有关，尤其是 Docker 配置。虽然我们努力支持 Docker 部署，但了解 Docker 基础知识对于顺利体验至关重要。

• Docker 部署支持：Open WebUI 支持 Docker 部署。假定用户已经熟悉 Docker。关于 Docker 入门，请参阅 官方 Docker 文档。

• 高级配置：设置反向代理以启用 HTTPS 和管理 Docker 部署需要一些基础知识。有许多在线资源可以帮助您学习这些技能。掌握这些知识将大大提升您使用 Open WebUI 及类似项目的体验。

🙏 感谢您！

无论大小，您的每一份贡献都对 Open WebUI 产生了重要影响。我们期待看到您为项目带来的精彩！

让我们共同努力，为社区打造一款更强大的工具。🌟