跳至内容

社区节点验证指南#

您希望n8n验证您的节点吗?

如果您希望将节点提交给n8n进行验证,请遵循以下指南。任何启用了已验证社区节点的用户都可以从n8n的节点面板中发现并安装已验证节点。

软件包来源验证#

  • 确认您的npm包仓库URL与预期的GitHub(或其他平台)仓库相匹配。
  • 确认npm和代码仓库中的软件包作者/维护者信息是否一致。
  • 确认npm中的git链接有效且代码仓库是公开的。
  • 确保您的软件包有完整的文档(README、使用示例等)。
  • 确保您的软件包许可证为MIT。

无外部依赖#

  • 确保您的软件包包含任何外部依赖项,以保持其轻量级且易于维护。

完善的文档#

  • 提供清晰的文档,无论是GitHub上的README文件还是相关API文档的链接。
  • 包含使用说明、示例工作流以及任何必要的认证信息。

无法访问环境变量或文件系统#

  • 代码严禁与环境变量交互或尝试读取/写入文件。
  • 通过节点参数传递所有必要数据。

遵循n8n最佳实践#

  • 保持清晰一致的编码风格。
  • 使用TypeScript并遵循n8n的节点开发指南
  • 确保正确的错误处理和验证。
  • 确保代码检查通过(换句话说,确保运行 npx @n8n/scan-community-package n8n-nodes-PACKAGE 能通过)。
优云智算