🤝 Вклад в проект

Sponsored by n8n

Does your interface have a backend yet? Try n8n

🚀 Добро пожаловать, участники проекта! 🚀

Мы высоко ценим ваш интерес к вкладу в Open WebUI. Этот документ поможет вам в процессе, чтобы ваши усилия эффективно улучшали проект. Давайте вместе сделаем Open WebUI еще лучше!

💡 Внесение вклада

Хотите внести вклад? Отлично! Вот как вы можете помочь:

🌟 Руководство по внесению изменений в код

Мы приветствуем пул-реквесты. Перед отправкой, пожалуйста:

1. Откройте обсуждение ваших идей здесь.
2. Следуйте стандартам кодирования проекта и добавьте тесты для новых функций.
3. Обновите документацию, если необходимо.
4. Пишите понятные и описательные сообщения коммитов.

🛠 Лучшие практики для PR с кодом:

1. Малые PR: Убедитесь, что ваши PR небольшие, фокусированные и охватывают одну задачу. Это облегчает процесс обзора кода и снижает вероятность появления нерелевантных проблем. Если объем изменений становится слишком большим, рассмотрите разделение их на меньшие, логически независимые PR.
2. Следуйте существующим стандартам кодирования: Убедитесь, что ваш код соответствует стандартам и практике кодирования проекта.
3. Избегайте дополнительных внешних зависимостей: Не добавляйте новые внешние зависимости без предварительного обсуждения.
4. Подход независимости от фреймворков: Мы стремимся быть независимыми от фреймворков. Реализуйте функции самостоятельно, когда это возможно, вместо использования внешних библиотек или фреймворков. Если у вас есть сомнения или предложения относительно этого подхода, не стесняйтесь обсудить их.

Спасибо за ваш вклад! 🚀

📚 Документация и учебные материалы

Помогите нам сделать 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/locale) в эту новую директорию и обновите значения строк в формате JSON в соответствии с вашим языком. Убедитесь, что структура объекта JSON сохранена.
• Добавьте код языка и его название в файл языков src/lib/i18n/locales/languages.json.

🤔 Вопросы и обратная связь

Есть вопросы или отзывы? Присоединяйтесь к нашему сообществу в Discord или откройте новую задачу. Мы готовы помочь!

🚨 Сообщение об ошибках

Заметили что-то странное? Есть идея? Проверьте нашу вкладку Issues, чтобы увидеть, было ли это уже сообщено или предложено. Если нет, смело открывайте новую задачу. При сообщении об ошибке, пожалуйста, следуйте шаблонам задач. Эти шаблоны созданы для обеспечения предоставления всех необходимых деталей с самого начала, что поможет нам быстро решить вашу проблему.

important

• Соответствие шаблону: Пожалуйста, обратите внимание, что несоблюдение предоставленного шаблона задачи или непредоставление запрошенной информации, скорее всего, приведет к закрытию вашей задачи без дальнейшего рассмотрения. Такой подход необходим для поддержания управляемости и честности при отслеживании задач.

• Детализация важна: Чтобы ваша проблема была понята и эффективно решена, крайне важно предоставить исчерпывающие детали. Описания должны быть четкими, включая шаги для воспроизведения, ожидаемый результат и фактический результат. Недостаток деталей может затруднить решение вашей проблемы.

🧭 Область поддержки

Мы заметили увеличение числа задач, которые не связаны непосредственно с Open WebUI, а скорее касаются окружения, в котором он запускается, особенно setups Docker. Хотя мы стремимся поддерживать развертывание Docker, понимание основ Docker имеет важное значение для успешного использования.

• Поддержка развертывания Docker: Open WebUI поддерживает развертывание через Docker. Предполагается, что вы знакомы с Docker. Для получения информации о Docker, пожалуйста, обратитесь к официальной документации Docker.

• Расширенные настройки: Настройка обратных прокси-серверов для HTTPS и управление развертываниями Docker требуют базовых знаний. Существует множество онлайн-ресурсов для изучения этих навыков. Убедитесь, что у вас есть эти знания, чтобы значительно улучшить ваш опыт работы с Open WebUI и аналогичными проектами.

🙏 Спасибо!

Ваш вклад, будь он большим или маленьким, оказывает значительное влияние на Open WebUI. Мы рады видеть, что вы принесёте в проект!

Вместе давайте создадим ещё более мощный инструмент для сообщества. 🌟