Share

Operator naming and coding conventions

The way a Bifrost node and its ports are named should tell the story of what the node does.

A Bifrost node's name should be short, descriptive, and searchable. It should tell the user what it does in a concise way that is as precise as possible. Its ports should tell the user what types of inputs are operated on, and what the user should expect to see as an output.

The operator naming and coding conventions help you write your nodes. With very few exceptions, these are only conventions and guidelines, and are not enforced by Bifrost.

Was this information helpful?