Skip to content

Scorecard - Nodes have examples #3

Description

@chrobione

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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions