> ## Documentation Index
> Fetch the complete documentation index at: https://alterxyz-a56768d7.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 插件开发者准则

> 本文档提供了Dify插件开发者在提交Pull Request前需要遵循的准则，包括確保插件功能正常、文档完整、提供独特价值，以及符合数据隐私和安全规范。包含了说明文档要求、应避免重复插件的指南以及隐私信息收集声明要求。

### 提交 Pull Request (PR) 之前

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

* 验证插件的功能是否正常运行。详细请参考[远程调试插件](https://alterxyz-a56768d7.mintlify.site/plugin_dev_zh/0411-remote-debug-a-plugin.zh.md)。
* 提供全面的 **README 文件**，包括：
  * 设置说明和使用指南。
  * 插件用户需用的代码、API、凭据或其他信息，以便连接插件到服务。
* 确保收集的用户信息仅用于连接服务和改进插件功能。
* 根据[插件隐私数据保护指南](https://alterxyz-a56768d7.mintlify.site/plugin_dev_zh/0312-privacy-protection-guidelines.zh.md)准备隐私政策内容文件或在线文档 URL。

2. **验证插件的贡献价值**

* 确保插件为 Dify 用户提供了独特价值。
* 插件应引入 Dify 或其他插件尚未提供的功能或服务。
* 遵循社区标准：
  * 内容非暴力，尊重全球用户群体。
  * 符合集成服务的相关政策。
* **如何检查是否已有类似插件？**
  * 避免提交与现有插件或 PR 重复的功能，除非新插件具备以下特点：
    * 引入新功能。
    * 提供性能改进。
  * **如何判断插件是否足够独特：**
    * 如果插件仅在现有功能上做出小幅调整（如添加语言参数），建议直接扩展现有插件。
    * 如果插件实现了重大功能变化（如优化批量处理或改进错误处理），可以提交为新插件。
    * 不确定？请在提交 PR 中附上简要说明，解释为什么需要提交新插件。

**示例：** 以Google 搜索插件为例，它接受单个输入查询并使用 Google 搜索 API 输出 Google 搜索结果列表。如果您提供具有类似底层实现的新 Google 搜索插件，但对输入进行了细微调整（例如添加新的语言参数），我们建议扩展现有插件。另一方面，如果您以新的方式实现了插件执行优化的批量搜索和错误处理能力，则可被视作单独的插件进行审核。

3. **确保插件符合下列隐私数据规范**

### 信息披露要求：

* 要求开发者在提交应用/工具时，**必须**声明是否收集任何类型的用户个人数据。详细请参考[插件隐私数据保护指南](https://alterxyz-a56768d7.mintlify.site/plugin_dev_zh/0312-privacy-protection-guidelines.zh.md)。
* 如果收集，需要**简单列出**收集的数据类型（例如：用户名、邮箱、设备ID、位置信息等），**无需过于详细**。
* 开发者**必须**提供隐私政策链接，隐私政策只需要陈述收集了什么信息、怎么使用这些信息、以及哪些信息会和第三方披露，以及第三方相关的隐私政策链接。

**审核重点：**

* **形式审核：** 检查是否按要求声明了数据收集情况。
* **高危数据排查：** 重点关注是否收集了敏感数据（例如：健康信息、财务信息、儿童个人信息等），如果收集了敏感数据，则需要**额外审核**其使用目的和安全性措施。
* **恶意行为排查：** 检查是否存在明显恶意行为，例如未经用户同意私自收集数据、上传用户数据到未知服务器等。

## 相关资源

* [插件开发基本概念](https://alterxyz-a56768d7.mintlify.site/plugin_dev_zh/0111-getting-started-dify-plugin.zh.md) - 了解插件开发基础
* [发布插件](https://alterxyz-a56768d7.mintlify.site/plugin_dev_zh/0321-release-overview.zh.md) - 插件发布流程概览
* [插件隐私数据保护指南](https://alterxyz-a56768d7.mintlify.site/plugin_dev_zh/0312-privacy-protection-guidelines.zh.md) - 编写隐私政策指南
* [发布至 Dify Marketplace](https://alterxyz-a56768d7.mintlify.site/plugin_dev_zh/0322-release-to-dify-marketplace.zh.md) - 在官方市场发布插件
* [远程调试插件](https://alterxyz-a56768d7.mintlify.site/plugin_dev_zh/0411-remote-debug-a-plugin.zh.md) - 插件调试指南


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.