🤝 Mitwirken

Gesponsert vonWarp

Das intelligente Terminal für Entwickler

🚀 Willkommen, Mitwirkende! 🚀

Ihr Interesse an einem Beitrag zu Open WebUI wird sehr geschätzt. Dieses Dokument soll Sie durch den Prozess führen und sicherstellen, dass Ihre Beiträge das Projekt effektiv verbessern. Lassen Sie uns Open WebUI gemeinsam noch besser machen!

💡 Beitragen

Möchten Sie etwas beitragen? Großartig! Hier erfahren Sie, wie Sie helfen können

🌟 Code-Beitragsrichtlinien

Wir freuen uns über Pull Requests. Bevor Sie einen einreichen, bitte

1. Eröffnen Sie hier eine Diskussion zu Ihren Ideen hier.
2. Befolgen Sie die Codierungsstandards des Projekts und fügen Sie Tests für neue Funktionen hinzu.
3. Aktualisieren Sie die Dokumentation nach Bedarf.
4. Schreiben Sie klare, aussagekräftige Commit-Nachrichten.

🛠 Beste Praktiken für Code-PRs:

1. Atomare PRs: Stellen Sie sicher, dass Ihre PRs klein und fokussiert sind und sich mit einem einzelnen Ziel oder einer einzelnen Aufgabe befassen. Dies erleichtert die Code-Überprüfung und begrenzt die Wahrscheinlichkeit, dass nicht zusammenhängende Probleme eingeführt werden. Wenn der Umfang der Änderungen zu groß wird, sollten Sie erwägen, sie in kleinere, logisch unabhängige PRs aufzuteilen.
2. Befolgen Sie die bestehende Code-Konvention: Stellen Sie sicher, dass Ihr Code mit den bestehenden Codierungsstandards und -praktiken des Projekts übereinstimmt.
3. Vermeiden Sie zusätzliche externe Abhängigkeiten: Fügen Sie keine zusätzlichen externen Abhängigkeiten ohne vorherige Absprache hinzu.
4. Framework-agnostischer Ansatz: Wir streben danach, Framework-agnostisch zu bleiben. Implementieren Sie Funktionalitäten nach Möglichkeit selbst, anstatt sich auf externe Frameworks oder Bibliotheken zu verlassen. Wenn Sie Zweifel oder Vorschläge zu diesem Ansatz haben, können Sie dies gerne besprechen.

Vielen Dank für Ihren Beitrag! 🚀

📚 Dokumentation & Tutorials

Helfen Sie uns, Open WebUI zugänglicher zu machen, indem Sie die Dokumentation verbessern, Tutorials schreiben oder Anleitungen zur Einrichtung und Optimierung der Web-Benutzeroberfläche erstellen.

🌐 Übersetzungen und Internationalisierung

Helfen Sie uns, Open WebUI einem breiteren Publikum zugänglich zu machen. In diesem Abschnitt führen wir Sie durch den Prozess des Hinzufügens neuer Übersetzungen zum Projekt.

Wir verwenden JSON-Dateien, um Übersetzungen zu speichern. Sie finden die vorhandenen Übersetzungsdateien im Verzeichnis src/lib/i18n/locales. Jedes Verzeichnis entspricht einer bestimmten Sprache, z. B. en-US für Englisch (USA), fr-FR für Französisch (Frankreich) usw. Sie können auf ISO 639 Sprachcodes verweisen, um den entsprechenden Code für eine bestimmte Sprache zu finden.

Um eine neue Sprache hinzuzufügen

• Erstellen Sie ein neues Verzeichnis im Pfad src/lib/i18n/locales mit dem entsprechenden Sprachcode als Namen. Wenn Sie beispielsweise Übersetzungen für Spanisch (Spanien) hinzufügen, erstellen Sie ein neues Verzeichnis namens es-ES.
• Kopieren Sie die amerikanischen englischen Übersetzungsdateien (aus dem Verzeichnis en-US in src/lib/i18n/locale) in dieses neue Verzeichnis und aktualisieren Sie die Zeichenfolgenwerte im JSON-Format entsprechend Ihrer Sprache. Stellen Sie sicher, dass die Struktur des JSON-Objekts erhalten bleibt.
• Fügen Sie den Sprachcode und seinen jeweiligen Titel zur languages-Datei unter src/lib/i18n/locales/languages.json hinzu.

🤔 Fragen & Feedback

Haben Sie Fragen oder Feedback? Treten Sie unserer Discord-Community bei oder eröffnen Sie ein Issue. Wir sind hier, um zu helfen!

🚨 Melden von Problemen

Haben Sie etwas Ungewöhnliches bemerkt? Eine Idee? Schauen Sie in unserem Issues-Tab nach, ob es bereits gemeldet oder vorgeschlagen wurde. Wenn nicht, eröffnen Sie gerne ein neues Issue. Wenn Sie ein Problem melden, befolgen Sie bitte unsere Issue-Vorlagen. Diese Vorlagen sind so konzipiert, dass von Anfang an alle notwendigen Details bereitgestellt werden, damit wir Ihre Anliegen effizienter bearbeiten können.

Wichtig

• Einhaltung der Vorlage: Bitte beachten Sie, dass die Nichtbeachtung der bereitgestellten Issue-Vorlage oder das Nichtbereitstellen der angeforderten Informationen dazu führt, dass Ihr Issue wahrscheinlich ohne weitere Prüfung geschlossen wird. Dieser Ansatz ist entscheidend für die Aufrechterhaltung der Handhabbarkeit und Integrität der Issue-Nachverfolgung.

• Details sind entscheidend: Um sicherzustellen, dass Ihr Problem verstanden und effektiv behoben werden kann, ist es unerlässlich, umfassende Details anzugeben. Beschreibungen sollten klar sein, einschließlich Schritte zur Reproduktion, erwartete Ergebnisse und tatsächliche Ergebnisse. Fehlende ausreichende Details können unsere Fähigkeit, Ihr Problem zu lösen, beeinträchtigen.

🧭 Umfang der Unterstützung

Wir haben eine Zunahme von Problemen festgestellt, die nicht direkt mit Open WebUI zusammenhängen, sondern mit der Umgebung, in der es ausgeführt wird, insbesondere mit Docker-Setups. Obwohl wir bestrebt sind, Docker-Bereitstellungen zu unterstützen, ist die Kenntnis der Docker-Grundlagen für eine reibungslose Erfahrung unerlässlich.

• Unterstützung bei der Docker-Bereitstellung: Open WebUI unterstützt die Docker-Bereitstellung. Grundkenntnisse in Docker werden vorausgesetzt. Für Docker-Grundlagen verweisen wir auf die offizielle Docker-Dokumentation.

• Erweiterte Konfigurationen: Die Einrichtung von Reverse-Proxys für HTTPS und die Verwaltung von Docker-Bereitstellungen erfordern grundlegende Kenntnisse. Es gibt zahlreiche Online-Ressourcen, um diese Fähigkeiten zu erlernen. Sicherzustellen, dass Sie über diese Kenntnisse verfügen, wird Ihre Erfahrung mit Open WebUI und ähnlichen Projekten erheblich verbessern.

🙏 Danke!

Ihre Beiträge, ob groß oder klein, haben einen erheblichen Einfluss auf Open WebUI. Wir sind gespannt, was Sie dem Projekt bringen!

Gemeinsam schaffen wir ein noch leistungsfähigeres Werkzeug für die Community. 🌟