Merge pull request #43452 from kponichtera/43451-contribution-guide-set-up-ide

Extended contribution guide with how to make IDEs recognize Moby’s repository as a Go project

7 files changed, 45 insertions, 4 deletions

diff --git a/docs/contributing/README.md b/docs/contributing/README.md
index 915c0cff1e..4fc5dcfd9b 100644
--- a/docs/contributing/README.md
+++ b/docs/contributing/README.md
@@ -3,6 +3,7 @@
  * [README first](who-written-for.md)
  * [Get the required software](software-required.md)
  * [Set up for development on Windows](software-req-win.md)
+ * (Optional) [Configure project for IDE](set-up-ide.md)
  * [Configure Git for contributing](set-up-git.md)
  * [Work with a development container](set-up-dev-env.md)
  * [Run tests and test documentation](test.md)
diff --git a/docs/contributing/images/ide_custom_gopath.png b/docs/contributing/images/ide_custom_gopath.png
new file mode 100644
index 0000000000..fc5e995266
--- /dev/null
+++ b/docs/contributing/images/ide_custom_gopath.png
diff --git a/docs/contributing/images/ide_go_modules_integration.png b/docs/contributing/images/ide_go_modules_integration.png
new file mode 100644
index 0000000000..b4bfa53385
--- /dev/null
+++ b/docs/contributing/images/ide_go_modules_integration.png
diff --git a/docs/contributing/images/ide_system_environment_gopath.png b/docs/contributing/images/ide_system_environment_gopath.png
new file mode 100644
index 0000000000..1f8c88f4d5
--- /dev/null
+++ b/docs/contributing/images/ide_system_environment_gopath.png
diff --git a/docs/contributing/set-up-ide.md b/docs/contributing/set-up-ide.md
new file mode 100644
index 0000000000..29d8ef5c58
--- /dev/null
+++ b/docs/contributing/set-up-ide.md
@@ -0,0 +1,36 @@
+### Configure project for IDE (optional)
+
+In this section you will configure the project in order to make use of [GoLand](https://www.jetbrains.com/go)
+integrated development environment's (IDE) features like syntax highlighting and code completion.
+
+## 1. Place repository to the GOPATH
+
+The repository has to be placed under `src` directory in GOPATH.
+The default location for Linux and macOS users is `~/go`, while for Windows it is `%USERPROFILE%\go`.
+
+Move the previously cloned repository or clone it again to the `<GOPATH>/src/github.com/docker/docker` directory.
+
+## 2. Configure IDE
+
+Open the `<GOPATH>/src/github.com/docker/docker` directory in GoLand.
+Then open the settings (Ctrl+Alt+S) and change two settings:
+
+1. Disable Go modules integration
+
+![Disabling Go modules integration](images/ide_go_modules_integration.png)
+
+3. Disable using system environment's GOPATH
+
+![Disabling using system environment's GOPATH](images/ide_system_environment_gopath.png)
+
+### Custom GOPATH
+
+In case the custom GOPATH is used (for example to have multiple copies of the cloned repository),
+it has to be configured in the settings as well:
+
+![Configuring custom GOPATH](images/ide_custom_gopath.png)
+
+## Where to go next
+
+Congratulations, you have finished configuring project to work with the IDE. 
+In the next section you'll [learn how to set up and work in a Moby development container](set-up-dev-env.md).
diff --git a/docs/contributing/software-req-win.md b/docs/contributing/software-req-win.md
index 55b370003f..0730fb586e 100644
--- a/docs/contributing/software-req-win.md
+++ b/docs/contributing/software-req-win.md
@@ -173,5 +173,7 @@ https://github.com/kevpar/docker-w2wCIScripts/blob/master/runCI/Invoke-DockerCI.
 
 ## Where to go next
 
-In the next section, you'll [learn how to set up and configure Git for
-contributing to Moby](set-up-git.md).
+In the next section, you'll [configure the project to be properly recognized by the IDE](set-up-ide.md).
+
+If you don't want to use IDE, you can proceed to the next step
+and [learn how to set up and configure Git for contributing to Moby](set-up-git.md).
diff --git a/docs/contributing/software-required.md b/docs/contributing/software-required.md
index b14c6f9050..b9d6950215 100644
--- a/docs/contributing/software-required.md
+++ b/docs/contributing/software-required.md
@@ -90,5 +90,7 @@ You must log out and log back in for this modification to take effect.
 
 ## Where to go next
 
-In the next section, you'll [learn how to set up and configure Git for
-contributing to Moby](set-up-git.md).
+In the next section, you'll [configure the project to be properly recognized by the IDE](set-up-ide.md).
+
+If you don't want to use IDE, you can proceed to the next step
+and [learn how to set up and configure Git for contributing to Moby](set-up-git.md).
\ No newline at end of file