Browse code
Extended contribution guide with how to enable GoLand IDE syntax highlighting and code completion in Moby project
Signed-off-by: Konrad Ponichtera <konpon96@gmail.com>
Konrad Ponichtera authored on 2022/04/03 23:03:05Showing 7 changed files
- docs/contributing/README.md
- docs/contributing/images/ide_custom_gopath.png
- docs/contributing/images/ide_go_modules_integration.png
- docs/contributing/images/ide_system_environment_gopath.png
- docs/contributing/set-up-ide.md
- docs/contributing/software-req-win.md
- docs/contributing/software-required.md
| ... | ... |
@@ -3,6 +3,7 @@ |
| 3 | 3 |
* [README first](who-written-for.md) |
| 4 | 4 |
* [Get the required software](software-required.md) |
| 5 | 5 |
* [Set up for development on Windows](software-req-win.md) |
| 6 |
+ * (Optional) [Configure project for IDE](set-up-ide.md) |
|
| 6 | 7 |
* [Configure Git for contributing](set-up-git.md) |
| 7 | 8 |
* [Work with a development container](set-up-dev-env.md) |
| 8 | 9 |
* [Run tests and test documentation](test.md) |
| 15 | 16 |
new file mode 100644 |
| ... | ... |
@@ -0,0 +1,36 @@ |
| 0 |
+### Configure project for IDE (optional) |
|
| 1 |
+ |
|
| 2 |
+In this section you will configure the project in order to make use of [GoLand](https://www.jetbrains.com/go) |
|
| 3 |
+integrated development environment's (IDE) features like syntax highlighting and code completion. |
|
| 4 |
+ |
|
| 5 |
+## 1. Place repository to the GOPATH |
|
| 6 |
+ |
|
| 7 |
+The repository has to be placed under `src` directory in GOPATH. |
|
| 8 |
+The default location for Linux and macOS users is `~/go`, while for Windows it is `%USERPROFILE%\go`. |
|
| 9 |
+ |
|
| 10 |
+Move the previously cloned repository or clone it again to the `<GOPATH>/src/github.com/docker/docker` directory. |
|
| 11 |
+ |
|
| 12 |
+## 2. Configure IDE |
|
| 13 |
+ |
|
| 14 |
+Open the `<GOPATH>/src/github.com/docker/docker` directory in GoLand. |
|
| 15 |
+Then open the settings (Ctrl+Alt+S) and change two settings: |
|
| 16 |
+ |
|
| 17 |
+1. Disable Go modules integration |
|
| 18 |
+ |
|
| 19 |
+ |
|
| 20 |
+ |
|
| 21 |
+3. Disable using system environment's GOPATH |
|
| 22 |
+ |
|
| 23 |
+ |
|
| 24 |
+ |
|
| 25 |
+### Custom GOPATH |
|
| 26 |
+ |
|
| 27 |
+In case the custom GOPATH is used (for example to have multiple copies of the cloned repository), |
|
| 28 |
+it has to be configured in the settings as well: |
|
| 29 |
+ |
|
| 30 |
+ |
|
| 31 |
+ |
|
| 32 |
+## Where to go next |
|
| 33 |
+ |
|
| 34 |
+Congratulations, you have finished configuring project to work with the IDE. |
|
| 35 |
+In the next section you'll [learn how to set up and work in a Moby development container](set-up-dev-env.md). |
| ... | ... |
@@ -173,5 +173,7 @@ https://github.com/kevpar/docker-w2wCIScripts/blob/master/runCI/Invoke-DockerCI. |
| 173 | 173 |
|
| 174 | 174 |
## Where to go next |
| 175 | 175 |
|
| 176 |
-In the next section, you'll [learn how to set up and configure Git for |
|
| 177 |
-contributing to Moby](set-up-git.md). |
|
| 176 |
+In the next section, you'll [configure the project to be properly recognized by the IDE](set-up-ide.md). |
|
| 177 |
+ |
|
| 178 |
+If you don't want to use IDE, you can proceed to the next step |
|
| 179 |
+and [learn how to set up and configure Git for contributing to Moby](set-up-git.md). |
| ... | ... |
@@ -90,5 +90,7 @@ You must log out and log back in for this modification to take effect. |
| 90 | 90 |
|
| 91 | 91 |
## Where to go next |
| 92 | 92 |
|
| 93 |
-In the next section, you'll [learn how to set up and configure Git for |
|
| 94 |
-contributing to Moby](set-up-git.md). |
|
| 93 |
+In the next section, you'll [configure the project to be properly recognized by the IDE](set-up-ide.md). |
|
| 94 |
+ |
|
| 95 |
+If you don't want to use IDE, you can proceed to the next step |
|
| 96 |
+and [learn how to set up and configure Git for contributing to Moby](set-up-git.md). |
|
| 95 | 97 |
\ No newline at end of file |