Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Scorecard - Nodes have examples #3

Open
chrobione opened this issue Jun 1, 2023 · 0 comments
Open

Scorecard - Nodes have examples #3

chrobione opened this issue Jun 1, 2023 · 0 comments

Comments

@chrobione
Copy link
Member

Examples
Requirements
The package SHOULD include example flows that demonstrate each node. The tool will check the examples folder (and any nested folders) for json flow files. It will then iterate over these files and look at the nodes used in the flows to ensure that all nodes declared in the package are used in an example at least once. Config nodes are excluded from the check.

Reason
Examples are an excellent way for users to understand how to use a node.

Reference
https://nodered.org/docs/creating-nodes/examples

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant