メインコンテンツまでスキップ

🤝 コントリビューション

Sponsored by n8n
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をよりアクセスしやすくするため、ドキュメントを改善したり、チュートリアルを書いたり、Web UIのセットアップや最適化に関するガイドを作成してください。

🌐 翻訳と国際化

Open WebUIをより多くの人々に利用可能にするためにご協力ください。このセクションではプロジェクトに新しい翻訳を追加するプロセスをガイドします。

翻訳はJSONファイルに保存されています。既存の翻訳ファイルはsrc/lib/i18n/localesディレクトリにあります。各ディレクトリは特定の言語に対応しており、例えば、英語(アメリカ)はen-US、フランス語(フランス)はfr-FRとなっています。特定の言語に適したコードを見つけるにはISO 639 Language Codesを参照してください。

新しい言語を追加するには:

  • src/lib/i18n/localesパスに適切な言語コードを名前として使用した新しいディレクトリを作成します。例えばスペイン語(スペイン)を追加する場合、新しいディレクトリ名はes-ESとします。
  • アメリカ英語の翻訳ファイル(src/lib/i18n/localeen-USディレクトリから)をこの新しいディレクトリにコピーし、JSON形式で構造を保持しながら自分の言語に合わせて文字列値を更新します。
  • 言語ファイルsrc/lib/i18n/locales/languages.jsonに言語コードとそれに対応するタイトルを追加します。

🤔 質問とフィードバック

質問やフィードバックがありますか?Discordコミュニティに参加するか、Issueを開いてください。私たちはお手伝いします!

🚨 問題を報告する

何か問題に気付きましたか?アイデアはありますか?Issuesタブを確認し、それがすでに報告されているか提案されているかを確認してください。そうでない場合は、新しいIssueを開いてください。問題を報告する際は、提供されたIssueテンプレートに従ってください。このテンプレートは、すべての必要な詳細を最初から提供し、懸念事項に効率的に対応できるよう設計されています。

important
  • テンプレート準拠: 提供されたIssueテンプレートに従わない場合、または必要な情報を全く提供しない場合、Issueがさらに考慮されることなく閉じられる可能性が高いです。このアプローチは、Issueトラッキングの管理能力と信頼性を維持するために重要です。

  • 詳細が重要: 問題を理解し効果的に対処するためには、包括的な詳細を含めることが不可欠です。説明は明確で、再現手順、期待される結果、実際の結果を含む必要があります。十分な詳細がないと、問題を解決する能力が妨げられる可能性があります。

🧭 サポート範囲

Open WebUIに直接関連していないが、特にDockerセットアップに関係する問題が増えていることに気づきました。Dockerでの展開をサポートしようとしていますが、Dockerの基本を理解することがスムーズな体験には不可欠です。

  • Docker展開サポート: Open WebUIはDocker展開をサポートします。Dockerについての基本知識があることを前提としています。Dockerの基本については公式Dockerドキュメントを参照してください。

  • 高度な設定: リバースプロキシを用いたHTTPS設定やDocker展開の管理には基本的な知識が必要です。これらのスキルを学ぶための多くのオンラインリソースが利用可能です。この知識を習得することで、Open WebUIや類似のプロジェクトをより良く活用することができます。

🙏 ありがとうございます!

皆さんの貢献、大きなものでも小さなものでも、Open WebUIに多大な影響を与えています。プロジェクトにどんな形で参加していただけるのか、とても楽しみです!

共に、コミュニティのためのさらに強力なツールを作り上げましょう。🌟