Add note in readme to guard against NPEs in cyclical states (#31)

* Add note in readme to guard against NPEs in cyclical states * rgrnwd to codeowners
block · Apr 29, 2024 · 64f7967 · 64f7967
1 parent bbb52e1
commit 64f7967
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -1 +1 @@
-* @synesso @cwmyers @aparkersquare @mmollaverdi @hugomd
+* @synesso @cwmyers @aparkersquare @mmollaverdi @hugomd @rgrnwd
diff --git a/README.md b/README.md
@@ -33,6 +33,11 @@ data object Amber : Color({ setOf(Red) })
 data object Red : Color({ setOf(Green) })
 ```
 
+<aside>
+Be sure to define your state constructor with functions rather than literal values if you require cycles in your state
+machine. Otherwise, you are likely to encounter null pointer exceptions.
+</aside>
+
 ### Value
 
 The value is responsible for knowing and updating its current state.