社区节点验证指南
您想让 n8n 验证您的节点吗?
如果您希望将节点提交给 n8n 进行验证,请在构建节点时遵循以下准则。任何启用了已验证社区节点的用户都可以从 n8n 的节点面板中发现并安装已验证节点。
包源验证
- 验证您的 npm 包存储库 URL 是否与预期的 GitHub(或其他平台)存储库匹配。
- 确认 npm 和存储库之间的包作者/维护者匹配。
- 确认 npm 中的 git 链接有效并且存储库是公开的。
- 确保您的包有适当的文档(自述文件、使用示例等)。
- 确保您的软件包许可证是 MIT。
无外部依赖
- 确保您的包不包含任何外部依赖项,以保持其轻量级且易于维护。
适当的文档
- 提供清晰的文档,无论是GitHub 上的README还是相关API 文档的链接。
- 包括使用说明、示例工作流程和任何必要的身份验证详细信息。
无法访问环境变量或文件系统
- 代码不能与环境变量交互或尝试读取/写入文件。
- 通过节点参数传递所有必要的数据。
遵循 n8n 最佳实践
- 保持清晰、一致的编码风格。
- 使用TypeScript并遵循 n8n 的节点开发指南。
- 确保正确的错误处理和验证。
- 确保 linter 通过(换句话说,确保运行通过)。
仅使用英语
- 节点界面和所有文档都必须仅使用英文。
- 这包括参数名称、描述、帮助文本、错误消息和自述文件内容。