发布至 Dify Marketplace

Dify Marketplace 致力于为使用 Dify 平台的全球用户提供更强大、更灵活的功能扩展,而您的贡献将进一步丰富这一平台的可能性。

无论您是首次提交插件的开发者,还是经验丰富的贡献者,我们希望通过本指引为您提供清晰的发布流程和最佳实践建议,让您的插件能够顺利发布,并为社区带来价值。

期待与您一起构建一个更加开放和创新的插件生态!

插件的发布流程

将插件发布至 Dify Marketplace 大致分为以下步骤:

  1. Fork Dify Plugin 代码仓库

  2. 创建新的分支,将插件的代码和 pkg 文件上传至对应的插件类目

  3. 提交 Pull Request (PR) ,等待审核

  4. 审核通过后,插件代码合并至 Main 分支,自动上线至 Dify Marketplace

插件的发布流程图:

The process

开发者职责

提交 Pull Request (PR) 之前

1. 确保插件功能正常且文档齐全

  • 验证插件的功能是否正常运行。

  • 提供全面的 README 文件,包括:

    • 设置说明和使用指南。

    • 用户需用的代码、API、凭据或其他信息,以便连接插件到服务。

  • 确保收集的用户信息仅用于连接服务和改进插件功能。

  1. 验证插件的贡献价值

  • 确保插件为 Dify 用户提供了独特价值。

  • 插件应引入 Dify 或其他插件尚未提供的功能或服务。

  • 遵循社区标准:

    • 内容非暴力,尊重全球用户群体。

    • 符合集成服务的相关政策。

  • 如何检查是否已有类似插件?

    • 避免提交与现有插件或 PR 重复的功能,除非新插件具备以下特点:

      • 引入新功能。

      • 提供性能改进。

    • 如何判断插件是否足够独特:

      • 如果插件仅在现有功能上做出小幅调整(如添加语言参数),建议直接扩展现有插件。

      • 如果插件实现了重大功能变化(如优化批量处理或改进错误处理),可以提交为新插件。

      • 不确定? 在提交 PR 中附上简要说明,解释为什么需要提交新插件。

示例:

以 Google 搜索插件为例,它接受单个输入查询并使用 Google 搜索 API 输出 Google 搜索结果列表。

如果您提供具有类似底层实现的新 Google 搜索插件,但对输入进行了细微调整(例如添加新的语言参数),我们建议扩展现有插件。

另一方面,如果您以新的方式实现了插件执行优化的批量搜索和错误处理能力,则可被视作单独的插件进行审核。


Pull Request (PR) 审核期间

积极回应审查人员的提问和反馈:

  • 14 天内未解决的 PR 评论将被标记为过时(可重新开启)。

  • 30 天内未解决的 PR 评论将被关闭(不可重新开启,需要创建新 PR)。


Pull Request (PR) 审核通过后

1. 持续维护

  • 处理用户报告的问题和功能请求。

  • 在发生重大 API 变更时迁移插件:

    • Dify 将提前发布变更通知和迁移说明。

    • Dify 工程师可提供迁移支持。

2. Marketplace 公开 Beta 测试阶段的限制

  • 避免对现有插件引入破坏性更改。


审核流程

1. 审核顺序

  • 按照 先到先审 的顺序处理 PR。审核将在 1 周内开始。如有延迟,审查人员将通过评论通知 PR 作者。

2. 审核重点

  • 检查插件名称、描述和设置说明是否清晰且具有指导性。

  • 检查插件的 Manifest 文件是否符合格式规范,并包含有效的作者联系信息。

  1. 插件的功能性和相关性

Dify.ai 保留接受或拒绝插件提交的权利。


常见问题

  1. 如何判断插件是否独特?

示例:一个 Google 搜索插件仅增加了语言参数,可能应作为现有插件的扩展提交。但如果插件实现了显著的功能改进(如优化批量处理或错误处理),则可以作为新插件提交。

  1. 如果我的 PR 被标记为过时或关闭怎么办?

被标记为过时的 PR 可以在解决反馈后重新开启。被关闭的 PR(超过 30 天)需要重新创建一个新 PR。

  1. Beta 测试阶段可以更新插件吗?

可以,但应避免引入破坏性更改。

Last updated