提交社区节点#
可能会发生变化
本文档中描述的标准适用于社区节点仓库的第一个版本。这些标准在未来版本中可能会发生变化。
社区节点是托管在 npm 注册表中的 npm 包。
在构建要提交到社区节点仓库的节点时,请使用以下资源确保您的节点设置正确:
标准#
要使您的节点在 n8n 社区节点仓库中可用,您必须:
- 确保包名以
n8n-nodes-
或@<scope>/n8n-nodes-
开头。例如,n8n-nodes-weather
或@weatherPlugins/n8n-nodes-weather
。 - 在您的包关键字中包含
n8n-community-node-package
。 - 确保您在
package.json
文件的n8n
属性中添加您的节点和凭据。参考入门节点中的 package.json作为示例。 - 使用代码检查器检查您的节点并在本地测试以确保其正常工作。
- 将包提交到 npm 注册表。参考 npm 的文档向注册表贡献包了解更多信息。
提交您的节点以供 n8n 验证#
n8n 审查已验证的社区节点。用户可以从 n8n 的节点面板中发现和安装已验证的社区节点。这些节点需要遵守某些技术和用户体验标准及约束。
在提交您的节点供 n8n 审查之前,您必须:
- 确保您的节点遵循已验证社区节点的技术指南并且所有自动检查都通过。具体来说,已验证的社区节点不允许使用任何运行时依赖项。
- 确保您的节点遵循用户体验指南。
- 确保节点具有适当的文档,形式为 npm 包中的 README 或相关的公共仓库。
- 将您的节点提交到 npm,因为 n8n 将从那里获取它进行最终审查。
如果您的节点满足以上所有要求,点击此处提交您的节点进行验证。