贡献模板
🌐 Contributing Templates
Mastra 社区在创建展示创新应用模式的模板方面起着至关重要的作用。本指南解释了如何将你自己的模板贡献到 Mastra 生态系统中。
🌐 The Mastra community plays a vital role in creating templates that showcase innovative application patterns. This guide explains how to contribute your own templates to the Mastra ecosystem.
模板贡献流程Direct link to 模板贡献流程
🌐 Template Contribution Process
1. 审查要求Direct link to 1. 审查要求
🌐 1. Review Requirements
在创建模板之前，请确保你了解：
🌐 Before creating a template, ensure you understand:
2. 开发你的模板Direct link to 2. 开发你的模板
🌐 2. Develop Your Template
按照既定模式创建你的模板：
🌐 Create your template following the established patterns:
- 专注于特定的用例或模式
- 包含完整的文档
- 使用全新安装进行彻底测试
- 遵循所有技术要求
- 确保 GitHub 仓库是模板仓库。如何创建模板仓库
3. 提交审核Direct link to 3. 提交审核
🌐 3. Submit for Review
一旦你的模板准备好，请通过我们的贡献表单提交。模板会经过审核流程，以确保质量和一致性。
🌐 Once your template is ready, submit it through our contribution form. Templates undergo an approval process to ensure quality and consistency.
提交指南Direct link to 提交指南
🌐 Submission Guidelines
模板标准Direct link to 模板标准
🌐 Template Criteria
我们接受符合以下条件的模板：
🌐 We accept templates that:
- 展示独特价值 - 展示现有模板未涵盖的创新用例或模式
- 遵循规范 - 遵守所有技术要求和结构指南
- 包含高质量文档 - 提供清晰的安装说明和使用示例
- 可靠工作 - 安装后设置最少即可正常运行
质量标准Direct link to 质量标准
🌐 Quality Standards
模板必须达到以下质量标准：
🌐 Templates must meet these quality benchmarks:
- 代码质量 - 代码清晰、注释完善且易于维护
- 错误处理 - 对外部 API 和用户输入进行适当的错误处理
- 类型安全 - 适当情况下使用 Zod 验证的完整 TypeScript 类型
- 文档 - 包含安装和使用说明的全面自述文件
- 测试 - 已验证可在全新安装中使用
提交流程Direct link to 提交流程
🌐 Submission Process
1. 准备你的模板Direct link to 1. 准备你的模板
🌐 1. Prepare Your Template
确保你的模板符合模板参考中列出的所有要求：
🌐 Ensure your template meets all requirements outlined in the Templates Reference:
src/mastra/目录中的正确项目结构- 标准 TypeScript 配置
- 综合
.env.example文件 - 包含安装说明的详细自述文件
2. 提交你的模板Direct link to 2. 提交你的模板
🌐 2. Submit Your Template
请使用我们的提交表格提交你的模板：
🌐 Submit your template using our contribution form:
必填信息Direct link to 必填信息
🌐 Required Information
提交模板时，请提供：
🌐 When submitting your template, provide:
- 模板名称 - 清晰、描述性名称，指示使用场景
- 模板作者名称 - 你的名称或机构名称
- 模板作者邮箱 - 用于就你的提交进行沟通的联系邮箱
- GitHub 链接 - 指向你的模板仓库的链接
- 描述 - 模板的功能及其价值的详细说明
- 可选图片 - 显示模板实际使用情况的截图或示意图
- 可选演示视频 - 链接到展示模板功能的视频
审查流程Direct link to 审查流程
🌐 Review Process
审查标准Direct link to 审查标准
🌐 Review Criteria
模板的评估标准包括：
🌐 Templates are evaluated on:
- 技术合规 - 遵守模板规则和规范
- 代码质量 - 干净、易维护且文档齐全的代码
- 独特性 - 新颖的用例或创新的实现模式
- 教育价值 - 能够有效地教授Mastra概念
- 社区利益 - 对更广泛的Mastra社区的潜在价值
反馈与迭代Direct link to 反馈与迭代
🌐 Feedback and Iteration
如果你的模板需要改进：
🌐 If your template needs improvements:
- 你将收到关于所需更改的具体反馈
- 进行所需修改并重新提交
- 审核过程会持续进行，直到模板达到标准
社区准则Direct link to 社区准则
🌐 Community Guidelines
模板创意Direct link to 模板创意
🌐 Template Ideas
考虑创建以下模板：
🌐 Consider creating templates for:
- 行业特定的使用案例 - 医疗、金融、教育等。
- 集成模式 - 特定的 API 或服务集成
- 高级技术 - 复杂工作流程、多智能体系统或新颖模式
- 学习资源 - 针对特定概念的逐步教程
开发最佳实践Direct link to 开发最佳实践
🌐 Development Best Practices
- 从简单开始 - 先从一个最小可运行的示例开始，然后逐步增加复杂性
- 彻底文档化 - 包含详细的注释和完整的自述文件
- 广泛测试 - 验证你的模板在不同环境下都能正常工作
- 寻求反馈 - 在提交前与社区分享以获得早期反馈
社区参与Direct link to 社区参与
🌐 Community Engagement
- 加入 Discord - 参与 Mastra Discord 社区
- 分享进展 - 向社区更新你的模板开发情况
- 帮助他人 - 协助其他贡献者完成他们的模板
- 保持更新 - 关注 Mastra 的新功能和规范
模板维护Direct link to 模板维护
🌐 Template Maintenance
持续责任Direct link to 持续责任
🌐 Ongoing Responsibilities
作为模板贡献者，你可能会被要求：
🌐 As a template contributor, you may be asked to:
- 更新依赖 - 使模板与最新的 Mastra 版本保持同步
- 修复问题 - 处理错误或兼容性问题
- 改进文档 - 根据用户反馈优化说明
- 添加功能 - 为模板扩展新功能
社区支持Direct link to 社区支持
🌐 Community Support
Mastra团队和社区提供：
🌐 The Mastra team and community provide:
- 技术指导 - 帮助解决复杂的实现难题
- 审查反馈 - 提供详细反馈以提升模板质量
- 推广 - 向社区展示已批准的模板
- 维护支持 - 帮助保持模板的最新状态
验证清单Direct link to 验证清单
🌐 Validation Checklist
在提交模板之前，请确认：
🌐 Before submitting a template, verify:
- 所有代码都组织在
src/mastra/目录下 - 使用标准的 Mastra TypeScript 配置
- 包括全面的
.env.example - 有详细的 README 和安装说明
- 没有单一仓库或网络框架的样板代码
- 在全新安装和环境配置后成功运行
- 遵循所有代码质量标准
- 展示了清晰且有价值的用例
社区展示Direct link to 社区展示
🌐 Community Showcase
模板库Direct link to 模板库
🌐 Template Gallery
已批准的模板将显示在：
🌐 Approved templates will be featured in:
- mastra.ai/templates - 社区模板库（即将推出）
- 文档 - 在相关文档部分中引用
- 社区亮点 - 在通讯和社区更新中展示
识别Direct link to 识别
🌐 Recognition
模板贡献者获得：
🌐 Template contributors receive:
- 署名 - 模板上的你的名称和联系信息
- 社区认可 - 在社区渠道中的认可
入门Direct link to 入门
🌐 Getting Started
准备好贡献一个模板了吗？
🌐 Ready to contribute a template?
- 探索现有模板 - 审查当前模板以获取灵感和模式
- 规划你的模板 - 定义使用场景和价值主张
- 遵循要求 - 确保符合所有技术要求
- 构建和测试 - 创建一个可用且文档完善的模板
- 提交审核 - 使用贡献表格提交你的模板
你的贡献有助于发展Mastra生态系统，并为整个社区提供宝贵的资源。我们期待看到你富有创意的模板！
🌐 Your contributions help grow the Mastra ecosystem and provide valuable resources for the entire community. We look forward to seeing your innovative templates!