Skip to content

Module Guidelines

everyoneishappy edited this page Feb 15, 2023 · 3 revisions

You have made a nice Fuse module! Hurrah!

Please check:

Pin names:

  • Use spaces to separate words all starting with upper case
  • Main input left, Enabled or Reset typically right

Metadata (Ctrl+M)

  • Does the module have a description?
  • Do any of the inputs or outputs need a description?
  • Does it make sense to add any tags?

Pipeline stage specific nodes

  • Does the module have pipeline specific nodes?
  • If yes can these be separated from the other functionality?
  • If the module is pipeline specific be sure to mention this in the description

Help patch

  • Should the module have a help patch? Remember you don’t need an exclusive patch, but can Ctril+H on the node in a contextual patch
  • Please ensure the help patch follows the help patch guidelines. A help patch without comments is like a doctor without pants

TODO: Functions

  • Clarify nomenclature around functions and function parameters