From 0bc2953ec1985c14515f51fbf878789214096d94 Mon Sep 17 00:00:00 2001 From: Eyal Bukchin Date: Thu, 24 Aug 2023 17:31:38 +0300 Subject: [PATCH] Update contributing.md (#101) * Update contributing.md * Changelog * Fix changelog file name * Update CONTRIBUTING.md Co-authored-by: Dmitry Dodzin --------- Co-authored-by: Dmitry Dodzin --- CONTRIBUTING.md | 10 +++++++--- changelog.d/+update-contributing-md.changed.md | 1 + 2 files changed, 8 insertions(+), 3 deletions(-) create mode 100644 changelog.d/+update-contributing-md.changed.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 665ddfc8..4ebe7299 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,10 +8,12 @@ issue. ## Building the IntelliJ plugin -First, [build the mirrord binaries](https://github.com/metalbear-co/mirrord/blob/main/CONTRIBUTING.md#build-and-run-mirrord) if not yet built. Then: +First, make sure you have JDK 17 installed. + +Then [build the mirrord binaries](https://github.com/metalbear-co/mirrord/blob/main/CONTRIBUTING.md#build-and-run-mirrord) if not yet built. Then: ```bash -cd intellij-ext +cd mirrord-intellij ``` ### On macOS @@ -19,6 +21,7 @@ cd intellij-ext ```bash cp /target/universal-apple-darwin/debug/libmirrord_layer.dylib . touch libmirrord_layer.so +mkdir -p bin/macos cp /target/universal-apple-darwin/debug/mirrord bin/macos/ ``` @@ -27,6 +30,7 @@ cp /target/universal-apple-darwin/debug/mirrord bin/macos/ ```bash cp /target/debug/libmirrord_layer.so . touch libmirrord_layer.dylib +mkdir -p bin/linux/x86-64 cp /target/debug/mirrord bin/linux/x86-64/mirrord ``` @@ -53,7 +57,7 @@ Now open the plugin's code in IntelliJ IDEA. Create a new Gradle run configurati Running this configuration in debug will open a new IDE window. You can set breakpoints in the plugin's code in the first window, and use the plugin in the second window to reach the breakpoints. -You can control which IDE is opened with a `PLATFORMTYPE` environment variable. For example, set `PLATFORMTYPE=IU` for IntelliJ IDEA Ultimate. +You can control which IDE is opened with a `PLATFORMTYPE` environment variable, as listed [here](https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html#intellij-extension-type). For example, set `PLATFORMTYPE=IU` for IntelliJ IDEA Ultimate. ## Adding E2E tests diff --git a/changelog.d/+update-contributing-md.changed.md b/changelog.d/+update-contributing-md.changed.md new file mode 100644 index 00000000..025f3d2b --- /dev/null +++ b/changelog.d/+update-contributing-md.changed.md @@ -0,0 +1 @@ +Update contributing.md