建立社区节点
可能会有变化
本文档中描述的标准适用于社区节点存储库的第一个版本。这些标准在未来的版本中可能会有所变化。
社区节点是 npm 包,托管在 npm 注册表中。
构建节点以提交到社区节点存储库时,请使用以下资源来确保您的节点设置正确:
标准
要使您的节点可供 n8n 社区节点存储库使用,您必须:
- 确保软件包名称以或开头。例如,或。
- 在您的包中包含关键字。
- 确保将节点和凭据添加到属性内的文件中。请参阅启动节点中的 package.json文件作为示例。
- 使用linter检查您的节点并在本地进行测试以确保其正常工作。
- 将软件包提交到 npm 注册表。有关更多信息,请参阅 npm 的“将软件包贡献到注册表”文档。
提交您的节点以供 n8n 验证
n8n 审核已验证的社区节点。用户可以在 n8n 的节点面板中发现并安装已验证的社区节点。这些节点需要遵守特定的技术和用户体验标准及约束。
在提交节点供 n8n 审核之前,您必须:
- 确保您的节点遵循已验证社区节点的技术指南,并通过所有自动检查。具体而言,已验证社区节点不得使用任何运行时依赖项。
- 确保您的节点遵循UX 指南。
- 确保节点在npm 包或相关公共存储库中具有以 README 形式提供的适当文档。
- 将您的节点提交给 npm,因为 n8n 将从那里获取它进行最终审核。
如果您的节点满足以上所有要求,
请点击此处提交您的节点进行验证。