テンプレートの貢献
Mastraコミュニティは、革新的なアプリケーションパターンを紹介するテンプレートの作成において重要な役割を果たしています。このガイドでは、Mastraエコシステムに独自のテンプレートを貢献する方法について説明します。
テンプレート貢献プロセス
1. 要件の確認
テンプレートを作成する前に、以下を理解していることを確認してください:
- テンプレートリファレンス - 技術要件と規約
- プロジェクト構造 - 標準的なMastraプロジェクトの構成
- コミュニティガイドラインと品質基準
2. テンプレートの開発
確立されたパターンに従ってテンプレートを作成してください:
- 特定のユースケースやパターンに焦点を当てる
- 包括的なドキュメントを含める
- 新規インストールで徹底的にテストする
- すべての技術要件に従う
- GitHubリポジトリがテンプレートリポジトリであることを確認する。テンプレートリポジトリの作成方法
3. レビューの提出
テンプレートの準備ができたら、貢献フォームを通じて提出してください。テンプレートは品質と一貫性を確保するための承認プロセスを経ます。
提出ガイドライン
テンプレートの基準
以下の条件を満たすテンプレートを受け付けています:
- 独自の価値を実証する - 既存のテンプレートでカバーされていない革新的な使用例やパターンを示す
- 規約に従う - すべての技術要件と構造ガイドラインに準拠する
- 質の高いドキュメントを含む - 明確なセットアップ手順と使用例を提供する
- 確実に動作する - インストール後、最小限のセットアップで正しく機能する
品質基準
テンプレートは以下の品質ベンチマークを満たす必要があります:
- コード品質 - クリーンで、適切にコメントされ、保守可能なコード
- エラーハンドリング - 外部APIとユーザー入力に対する適切なエラーハンドリング
- 型安全性 - 適切な場合はZodバリデーションを含む完全なTypeScript型付け
- ドキュメント - セットアップと使用手順を含む包括的なREADME
- テスト - 新規インストールで動作することが検証済み
提出プロセス
1. テンプレートの準備
テンプレートが Templates Reference に記載の要件をすべて満たしていることを確認してください:
src/mastra/
ディレクトリ配下の適切なプロジェクト構成- 標準的な TypeScript 設定
- 充実した
.env.example
ファイル - セットアップ手順を含む詳細な README
2. テンプレートの提出
寄稿フォームからテンプレートを提出してください:
必要情報
テンプレートを提出する際は、次の情報をご提供ください:
- Template Name - ユースケースが分かる明確で説明的な名前
- Template Author Name - ご本人または組織名
- Template Author Email - 提出に関する連絡先メールアドレス
- GitHub URL - テンプレートのリポジトリへのリンク
- Description - テンプレートの機能と価値の詳細な説明
- Optional Image - テンプレートの動作を示すスクリーンショットまたは図
- Optional Demo Video - テンプレートの機能をデモする動画へのリンク
レビュープロセス
レビュー基準
テンプレートは以下の項目で評価されます:
- 技術的準拠 - テンプレートのルールと規約への準拠
- コード品質 - 清潔で保守可能、かつ十分に文書化されたコード
- 独自性 - 新しいユースケースや革新的な実装パターン
- 教育的価値 - Mastraの概念を効果的に教える能力
- コミュニティへの貢献 - より広いMastraコミュニティへの潜在的価値
フィードバックと反復
テンプレートに改善が必要な場合:
- 必要な変更について具体的なフィードバックを受け取ります
- 要求された修正を行い、再提出してください
- テンプレートが基準を満たすまでレビュープロセスが続きます
コミュニティガイドライン
テンプレートのアイデア
以下のようなテンプレートの作成を検討してください:
- 業界固有のユースケース - ヘルスケア、金融、教育など
- 統合パターン - 特定のAPIやサービス統合
- 高度なテクニック - 複雑なワークフロー、マルチエージェントシステム、または新しいパターン
- 学習リソース - 特定の概念に対するステップバイステップのチュートリアル
開発のベストプラクティス
- シンプルに始める - 最小限の動作例から始めて、徐々に複雑さを追加する
- 徹底的にドキュメント化する - 詳細なコメントと包括的なREADMEを含める
- 広範囲にテストする - テンプレートが異なる環境で動作することを確認する
- フィードバックを求める - 提出前にコミュニティと共有して早期フィードバックを得る
コミュニティエンゲージメント
- Discordに参加 - Mastra Discordコミュニティ に参加する
- 進捗を共有 - テンプレート開発の進捗をコミュニティに報告する
- 他の人を助ける - 他の貢献者のテンプレートを支援する
- 最新情報を把握 - 新しいMastraの機能と規約を追跡する
テンプレートのメンテナンス
継続的な責任
テンプレート貢献者として、以下のことを求められる場合があります:
- 依存関係の更新 - テンプレートを最新のMastraバージョンに対応させる
- 問題の修正 - バグや互換性の問題に対処する
- ドキュメントの改善 - ユーザーフィードバックに基づいて説明を強化する
- 機能の追加 - 新しい機能でテンプレートを拡張する
コミュニティサポート
Mastraチームとコミュニティは以下を提供します:
- 技術的ガイダンス - 複雑な実装課題のサポート
- レビューフィードバック - テンプレート品質向上のための詳細なフィードバック
- プロモーション - 承認されたテンプレートをコミュニティに紹介
- メンテナンス支援 - テンプレートを最新状態に保つためのサポート
検証チェックリスト
テンプレートを提出する前に、以下を確認してください:
- すべてのコードが
src/mastra/
ディレクトリに整理されている - 標準的なMastra TypeScript設定を使用している
- 包括的な
.env.example
が含まれている - セットアップ手順を含む詳細なREADMEがある
- モノレポやWebフレームワークのボイラープレートが含まれていない
- 新規インストールと環境設定後に正常に動作する
- すべてのコード品質基準に従っている
- 明確で価値のあるユースケースを実証している
コミュニティショーケース
テンプレートギャラリー
承認されたテンプレートは以下で紹介されます:
- mastra.ai/templates - コミュニティテンプレートギャラリー(近日公開予定)
- ドキュメント - 関連するドキュメントセクションで参照
- コミュニティハイライト - ニュースレターやコミュニティアップデートで紹介
表彰
テンプレート貢献者は以下を受け取ります:
- 帰属表示 - テンプレートにあなたの名前と連絡先情報を記載
- コミュニティでの認知 - コミュニティチャンネルでの謝辞
はじめに
テンプレートの貢献準備はできましたか?
- 既存のテンプレートを探索する - インスピレーションとパターンのために現在のテンプレートをレビューする
- テンプレートを計画する - ユースケースと価値提案を定義する
- 要件に従う - すべての技術要件への準拠を確保する
- 構築とテスト - 動作する、よく文書化されたテンプレートを作成する
- レビューのために提出する - 貢献フォームを使用してテンプレートを提出する
あなたの貢献はMastraエコシステムの成長を助け、コミュニティ全体に価値あるリソースを提供します。あなたの革新的なテンプレートを見ることを楽しみにしています!