From d7e0fc3bed9fa5d04705e29bb10a92f6d5549d46 Mon Sep 17 00:00:00 2001 From: jshlbrd Date: Wed, 23 Oct 2024 19:03:36 -0700 Subject: [PATCH] docs: Add Message Flags to CONTRIBUTING --- CONTRIBUTING.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9baf0262..b2c8a282 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,6 +13,7 @@ Thank you so much for your interest in contributing to Substation! This document [Development](#development) + [Development Environment](#development-environment) + + [Messages](#messages) + [Conditions](#conditions) + [Transforms](#transforms) + [Testing](#testing) @@ -48,6 +49,12 @@ Enhancements should be submitted as issues using the issue template. The project supports development through the use of [Visual Studio Code configurations](https://code.visualstudio.com/docs/remote/containers). The VS Code [development container](.devcontainer/Dockerfile) contains all packages required to develop and test changes locally before submitting pull requests. +### [Messages](message/) + +Each message can have a series of flags attached to it that are used to determine how the message should be processed by the system. These flags are exported as iota constants and should use verb style naming, such as: +- `IsControl` +- `SkipMissingValues` + ### [Conditions](condition/) Each condition should be functional and solve a single problem, and each one is nested under a "family" of conditions. (We may ask that you split complex condition logic into multiple conditions.) For example, there is a family for string comparisons: