Adding a note re unit test.

We now require ading unit test for every package. Adding a respective note to the readme. Signed-off-by: Alexander Chuzhoy <[email protected]>
achuzhoy · Apr 16, 2024 · dec7aa3 · dec7aa3
1 parent 73e6e0d
commit dec7aa3
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -111,6 +111,7 @@ The project uses a development method - forking workflow
    the [eco-goinfra](https://github.com/openshift-kni/eco-goinfra).
 8) The pull request gets approved from at least 2 reviewers for merge and is merged into
    the [eco-goinfra](https://github.com/openshift-kni/eco-goinfra) .
+#### Note: Every new package requires a coverage of <ins>ALL</ins> its public functions with unit tests. Examples of unit tests can be found in the repo and are located in the same folder with the package they cover and named after the CRD, for example [configmap_test.go](./pkg/configmap/configmap_test.go) or [metallb_test.go](./pkg/metallb/metallb_test.go).
 
 ### Code conventions
 #### Lint
@@ -144,4 +145,4 @@ func Function(
     argInt1, argInt2 int, argString1, argString2 string, argSlice1, argSlice2 []string) {
 
 }
-```
+```