From be2ea81177fef8461d323c3c212b1c7d34b8b629 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Alexis=20M=C3=A9taireau?= <alexis@notmyidea.org>
Date: Sun, 17 Oct 2021 15:50:28 +0200
Subject: [PATCH] Add some comments for readability.

---
 .github/workflows/dockerhub.yml | 2 +-
 docker-compose.test.yml         | 1 +
 docker-compose.yml              | 2 ++
 3 files changed, 4 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/dockerhub.yml b/.github/workflows/dockerhub.yml
index 930ffb5d..84370d1a 100644
--- a/.github/workflows/dockerhub.yml
+++ b/.github/workflows/dockerhub.yml
@@ -15,7 +15,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
 
-      - name: Test image
+      - name: Test image # Checks we are able to run the container.
         run: docker compose -f docker-compose.test.yml run sut
 
   build:
diff --git a/docker-compose.test.yml b/docker-compose.test.yml
index a3e19a96..818c3b16 100644
--- a/docker-compose.test.yml
+++ b/docker-compose.test.yml
@@ -1,3 +1,4 @@
+# This is used by Github actions to ensure docker images build properly.
 version: "3.9"
 
 services:
diff --git a/docker-compose.yml b/docker-compose.yml
index a8c9f57c..22b54e34 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -1,3 +1,5 @@
+# This is an example. Please change the configuration variables listed here.
+
 version: "3.9"
 
 services: