Add experimental package directory, decision record

README.md

@@ -27,8 +27,7 @@ that backend,
 a concrete implementation
 must be written for it.
 
-Here's a list of backends
-that are currently supported:
+Here's a list of backends that are currently supported:
 
 | Backend       | Link     |
 | :------------- | :------------- |
@@ -142,7 +141,7 @@ which we believe are useful, including:
 * Concrete implementations can be written once
   and distributed as libraries.
 
-* [Decorator Patterns][].
+* Decorator Patterns
 
 * Built-in concurrency controls into *Server*.
 
@@ -151,7 +150,6 @@ which we believe are useful, including:
 
 * Transaction-based *Receivers*.
 
-[Decorator Patterns]: ./doc/decorator_patterns.md
 [pub-sub]: https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern
 [http_handler]: https://golang.org/pkg/net/http/#HandlerFunc.ServeHTTP
-[http_responsewriter]: https://golang.org/pkg/net/http/#ResponseWriter
+[http_responsewriter]: https://golang.org/pkg/net/http/#ResponseWriter

docs/decisions/2024-07-09-experimental-changes

@@ -0,0 +1,33 @@
+---
+Date: 2024/07/09
+Authors: @Xopherus, @shezadkhan137
+Status: Accepted
+---
+
+# Experimental Libraries 
+
+## Context
+
+Go-msg is an open source library, although primarily used internally (at ZeroFox).
+There are new features and changes we wish to implement, 
+although it is sometimes difficult to merge because we have
+a higher standard for excellence (given the code is open source).
+
+It would be useful to have a mechanism to indicate that changes we introduce can be experimental (not production ready),
+and should be used at your own risk. 
+This would allow us to innovate with additional backends, decorators, and primitives
+without changing the core of the library
+until we are confident that such changes should be accepted.
+
+## Decision
+
+We will create an `go-msg/x/` directory which will house experimental features.
+We chose this model after [Go's experimental libraries](https://pkg.go.dev/golang.org/x/exp#section-readme).
+
+As a caveat, packages here are **experimental and unreliable**. They may be promoted to the main package,
+modified entirely, or removed. 
+
+## Consequences
+
+Every experimental package introduced should be accompanied with a Decision Record, 
+indicating what we're adding and why.

x/README.md

@@ -0,0 +1,6 @@
+# Experimental Packages (x)
+
+This directory holds experimental packages ([decision record](../docs/decisions/2024-07-09-experimental-changes)).
+The intent is to introduce new features which may or may not become a part of the core library.
+
+Code in this directory may not be backwards compatible.