Skip to content

Latest commit

 

History

History
133 lines (90 loc) · 3.33 KB

File metadata and controls

133 lines (90 loc) · 3.33 KB

贡献指南

感谢你对 GTPlanner 的关注!我们欢迎各种形式的贡献。


贡献 Prefab(最推荐)

这是最简单、最有影响力的贡献方式!

为什么贡献 Prefab?

每个 Prefab 都会:

  • 扩展 GTPlanner 的规划能力 - 让 GTPlanner 知道一个新的解决方案
  • 被自动推荐 - 纳入 community-prefabs.json 后会被推荐系统使用
  • 帮助整个社区 - 其他开发者可以直接使用你的 Prefab
  • 获得认可 - 在社区中建立影响力

快速开始

  1. 使用 Prefab 模板 创建你的 Prefab
  2. 开发并测试你的功能
  3. 在 GitHub 上发布 Release(包含 .whl 文件)
  4. prefabs/releases/community-prefabs.json 提交 PR
  5. 等待自动验证和审核
  6. 合并后自动部署到 Prefab 平台

Prefab 类型示例

  • 媒体处理: 视频转换、字幕提取、图片处理
  • 文档处理: PDF 解析、Excel 分析、格式转换
  • AI 服务: 语音识别、图像描述、文本摘要
  • API 集成: 天气查询、地图服务、消息推送

详细指南

完整的 Prefab 贡献流程、代码示例、测试要求等,请查看:

Prefab 完整贡献指南

该文档包含:

  • 详细的准备工作和环境配置
  • 代码编写规范和示例
  • Manifest 文件说明
  • 测试和验证步骤
  • PR 提交流程
  • 自动化检查说明
  • 审核流程和时间线
  • 故障排除指南

贡献核心代码

通过评测驱动的开发方式,提升 GTPlanner 的规划质量和系统性能。请遵循以下流程:

  1. Fork 本仓库
  2. 创建功能分支 (git checkout -b feature/amazing-feature)
  3. 编写代码并添加测试
  4. 确保所有测试通过
  5. 提交更改 (git commit -m 'feat: add amazing feature')
  6. 推送到分支 (git push origin feature/amazing-feature)
  7. 创建 Pull Request

分享实践案例

分享您的使用经验,帮助社区发掘 GTPlanner 的全部潜力:

  • 使用案例:真实项目中的应用
  • GTPlanner 生成的 PRD:展示规划质量
  • 教程和最佳实践:帮助新用户上手

提交案例 → 在 docs/examples/community-cases/ 创建 PR


贡献优先级

高优先级(最有价值)

  1. 贡献 Prefab - 直接扩展 GTPlanner 能力
  2. 分享 PRD 案例 - 展示真实效果
  3. 修复 Bug - 提高稳定性

中优先级

  1. 改进文档 - 降低使用门槛
  2. 新功能 - 增强功能
  3. 翻译 - 支持更多语言

低优先级

  1. 代码重构 - 需要充分理由
  2. 样式调整 - 非关键性改进

Pull Request 检查清单

提交 PR 前确认:

  • 代码遵循项目规范
  • 所有测试通过
  • 添加了必要的测试
  • 更新了相关文档
  • Commit 信息清晰
  • PR 描述详细

行为准则

  • 尊重所有贡献者
  • 保持友好和专业
  • 接受建设性反馈
  • 帮助新贡献者

相关资源


感谢你的贡献!