社区节点验证指南#
您希望 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
通过)。