doc generating mocks

arcalot · Sep 9, 2024 · 937ac89 · 937ac89
1 parent ac43f23
commit 937ac89
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/CONTRIBUTING.md 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 ./...
+```