Skip to content

Commit

Permalink
docs: Add Message Flags to CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
jshlbrd committed Oct 24, 2024
1 parent 16bbfdd commit d7e0fc3
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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:
Expand Down

0 comments on commit d7e0fc3

Please sign in to comment.