From 937ac89601f9f52b69d40409378e007cf4d8c4f6 Mon Sep 17 00:00:00 2001
From: Matthew F Leader <mleader@redhat.com>
Date: Mon, 9 Sep 2024 14:31:45 -0400
Subject: [PATCH] doc generating mocks

---
 CONTRIBUTING.md | 11 +++++++++++
 1 file changed, 11 insertions(+)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..4c96dd2
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,11 @@
+# Contributing
+
+## Generating Mocks
+
+As of writing, the mock objects are generated in this project's `mock` directory. When a given component is altered and its test suite depends upon a mock object new mocks need to be generated in the `mock` directory to replace the now outdated mocks. 
+
+To generate new mocks, while in this project's root directory execute this command:
+
+```shell
+go generate ./...
+```