From 61aea1a06f4ab32213cd1b2ad4f34c4d33b4a2c6 Mon Sep 17 00:00:00 2001
From: Achilleas Koutsou <achilleas@koutsou.net>
Date: Thu, 26 Oct 2023 20:46:22 +0200
Subject: [PATCH] test/README: run go tests when updating images

Add a small paragraph with the instruction to run the go tests when
pulling in a new version of images as a guide for making sure that
osbuild-composer builds and runs successfully, before moving on to
integration tests.
---
 test/README.md | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

diff --git a/test/README.md b/test/README.md
index 4deaffdd2..3c57f8e30 100644
--- a/test/README.md
+++ b/test/README.md
@@ -75,8 +75,20 @@ go mod edit -replace github.com/osbuild/images=github.com/<username>/images@<com
 ./tools/prepare-source.sh
 ```
 
-This will allow you to open a test PR and run the osbuild-composer integration
-tests against your updated code.
+Using the URL of the remote fork and branch will allow you to open a test PR
+and run the osbuild-composer integration tests against your updated code.
+
+Make sure you modify any code in osbuild-composer to adapt to the changes in
+the images repository. The images API is not considered stable and changes can
+occur frequently. A good quick check that everything compiles and _mostly_ runs
+correctly is by running the unit tests:
+```
+go test ./...
+```
+and some static checks:
+```
+go vet ./...
+```
 
 The changes to the `go.mod`, `go.sum`, and `vendor/` directory should be added
 in a separate commit from any other changes. The PR should not be merged with