From 24fa24d4146e1fe3d11b90558906b35ea19123b3 Mon Sep 17 00:00:00 2001
From: Cody Kaup <35509748+codykaup@users.noreply.github.com>
Date: Tue, 18 Jun 2024 15:52:05 -0500
Subject: [PATCH] doc: Add note for Go module names

---
 .../uploading-coverage-in-advanced-scenarios.md                | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/docs/coverage-reporter/uploading-coverage-in-advanced-scenarios.md b/docs/coverage-reporter/uploading-coverage-in-advanced-scenarios.md
index ffcba2d4a8..e8cdb99681 100644
--- a/docs/coverage-reporter/uploading-coverage-in-advanced-scenarios.md
+++ b/docs/coverage-reporter/uploading-coverage-in-advanced-scenarios.md
@@ -77,6 +77,9 @@ bash <(curl -Ls https://coverage.codacy.com/get.sh) report \
     --force-coverage-parser go -r unit.coverage.out
 ```
 
+!!! note
+    The module should match the project directory name. For example, a directory structure of `my-project/go.mod` should have `module my-project` or `module github.com/myusername/myrepo/my-project` instead of `module myproject` at the top of `go.mod`.
+
 ## Uploading coverage for unsupported languages {: id="unsupported-languages"}
 
 If your language isn't in the [list of supported languages](index.md#generating-coverage), you can still send coverage to Codacy.