跳转至

社区节点验证指南#

您想要 n8n 验证您的节点吗?

如果您想要将节点提交给 n8n 进行验证,请在构建节点时考虑遵循这些指南。启用了已验证社区节点的任何用户都可以从 n8n 的节点面板中发现和安装已验证的节点,适用于所有部署类型(自托管和 n8n Cloud)。

包源代码验证#

  • 验证您的 npm 包仓库 URL 与预期的 GitHub(或其他平台)仓库匹配。
  • 确认包作者/维护者在 npm 和仓库之间匹配。
  • 确认 npm 中的 git 链接正常工作且仓库是公开的。
  • 确保您的包有适当的文档(README、使用示例等)。
  • 确保您的包许可证是 MIT。

无外部依赖#

  • 确保您的包包含任何外部依赖,以保持轻量和易于维护。

适当的文档#

  • 提供清晰的文档,无论是 GitHub 上的 README 还是相关 API 文档的链接。
  • 包括使用说明、示例工作流和任何必要的身份验证详细信息。

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

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

遵循 n8n 最佳实践#

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

仅使用英语#

  • 节点界面和所有文档都必须仅使用英语
  • 这包括参数名称、描述、帮助文本、错误信息和 README 内容。
此页面是否
💬 微信

🚀 与作者交流

关注公众号
n8n实战笔记公众号
n8n实战笔记
📚 教程 💡 案例 🔧 技巧
添加微信
添加作者微信
1对1 专业指导
⚡ 快答 🎯 定制 🚀 支持