社区节点验证指南#
希望 n8n 验证您的节点吗?
如果您希望提交节点供 n8n 验证,在构建节点时请考虑遵循以下指南。任何启用了已验证社区节点的用户都可以从 n8n 的节点面板中发现并安装已验证节点。
包源码验证#
- 验证您的 npm 包仓库 URL 是否与预期的 GitHub(或其他平台)仓库匹配。
- 确认 npm 和仓库中的包作者/维护者信息一致。
- 确认 npm 中的 git 链接有效且仓库是公开的。
- 确保您的包有适当的文档(README、使用示例等)。
- 确保您的包采用 MIT 许可证。
无外部依赖#
- 确保您的包不包含任何外部依赖,以保持轻量级和易于维护。
完善的文档#
- 提供清晰的文档,无论是 GitHub 上的 README 还是相关 API 文档 的链接。
- 包含使用说明、示例工作流以及任何必要的身份验证细节。
不访问环境变量或文件系统#
- 代码不得与环境变量交互或尝试读取/写入文件。
- 所有必要数据都应通过节点参数传递。
遵循 n8n 最佳实践#
- 保持清晰一致的编码风格。
- 使用 TypeScript 并遵循 n8n 的 节点开发指南。
- 确保正确的错误处理和验证。
- 确保通过 linter 检查(即运行
npx @n8n/scan-community-package n8n-nodes-PACKAGE
能够通过)。