From 320921a63e541a92099ff563434ad08b69615f66 Mon Sep 17 00:00:00 2001
From: b1ackd0t <blackd0t@protonmail.com>
Date: Fri, 25 Aug 2023 16:51:11 +0300
Subject: [PATCH] Add Comment to docker compose project name (#1895)

Signed-off-by: rodneyosodo <blackd0t@protonmail.com>
---
 Makefile | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Makefile b/Makefile
index 68f6e57c..27f212cc 100644
--- a/Makefile
+++ b/Makefile
@@ -17,6 +17,7 @@ USER_REPO ?= $(shell git remote get-url origin | sed -e 's/.*\/\([^/]*\)\/\([^/]
 BRANCH ?= $(shell git rev-parse --abbrev-ref HEAD  2>/dev/null || git describe --tags --abbrev=0  2>/dev/null )
 empty:=
 space:= $(empty) $(empty)
+# Docker compose project name should follow this guidelines: https://docs.docker.com/compose/reference/#use--p-to-specify-a-project-name
 DOCKER_PROJECT ?= $(shell echo $(subst $(space),,$(USER_REPO)_$(BRANCH)) | tr -c -s '[:alnum:][=-=]' '_' | tr '[:upper:]' '[:lower:]')
 DOCKER_COMPOSE_COMMANDS_SUPPORTED := up down config
 DEFAULT_DOCKER_COMPOSE_COMMAND  := up