From ecb572b93f42f27166ae4c33cbebb72653f2d0ec Mon Sep 17 00:00:00 2001
From: Dominic Cooney <dominic.cooney@sourcegraph.com>
Date: Mon, 22 Jul 2024 01:45:38 -0700
Subject: [PATCH] Update CONTRIBUTING.md with Windows, ARM64 development notes
 (#1929)

Following these instructions, I have a working JetBrains build in
Windows 11 ARM64/UTM hosted on macOS.

## Test plan

Docs-only change.
---
 CONTRIBUTING.md | 47 ++++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 40 insertions(+), 7 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d201847b9b..1a9e77fa23 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -13,15 +13,42 @@ our [issue tracker](https://github.com/sourcegraph/cody/issues/new/choose).
 
 ### Prerequisites
 
-- Java 11: we recommend installing via SDKMAN! https://sdkman.io. Once you have SDKMAN! installed,
-  run `sdk use java 11.0.15-tem`.
-  Confirm that you have Java 11 installed with `java -version`.
-- Set up the Cody agent dev environment.
-    - Clone `https://github.com/sourcegraph/cody` in a sibling directory.
-    - Install its dependencies. The easiest way
+**Java 11:** we recommend installing via SDKMAN! https://sdkman.io. Once you have SDKMAN! installed,
+run `sdk use java 11.0.15-tem`. Confirm that you have Java 11 installed with `java -version`.
+
+> 🤞 On Windows, SDKMAN requires some Linux tools. If you don't have WSL, use the git bash environment and then:
+>
+> ```
+> winget install -e --id GnuWin32.Zip
+> mkdir ~/bin
+> cp /usr/bin/unzip ~/bin/zip  # Yes, unzip and zip are the same binary
+> curl -s "https://beta.sdkman.io" | bash
+> source "${HOME}/.sdkman/bin/sdkman-init.sh"
+> sdk selfupdate force
+> sdk use java 11.0.15-tem
+> ```
+  
+**Set up the Cody agent dev environment:**
+
+- Clone `https://github.com/sourcegraph/cody` in a sibling directory.
+- Install its dependencies. The easiest way
       is [with `asdf`](https://github.com/sourcegraph/cody/blob/main/doc/dev/index.md). If not using `asdf`, you just
       need to install the dependency versions listed in the `.tool-versions` file in that repository.
-    - From the root directory of the repository, `cd ./agent && pnpm install && pnpm build`
+- From the root directory of the repository, `cd ./agent && pnpm install && pnpm build`
+
+> 🤞 On Windows ARM64:
+> - There's no Chromium aarch64 binary (installed by Puppeteer)
+> - There's no sentry-cli aarch64 binary (Sentry.)
+>
+> To skip fetching these binaries, run:
+> 
+> ```
+> $env:PUPPETEER_SKIP_CHROMIUM_DOWNLOAD="true"
+> $env:SENTRYCLI_SKIP_DOWNLOAD=1
+> pnpm install
+> ```
+>
+> From this point, YMMV, but you should be able to build agent!
 
 ### Running
 
@@ -39,6 +66,12 @@ our [issue tracker](https://github.com/sourcegraph/cody/issues/new/choose).
 | Reformat Java and Kotlin sources                                                                                                    | `./gradlew spotlessApply`                                                |
 | Debug agent JSON-RPC communication                                                                                                  | `tail -f build/sourcegraph/cody-agent-trace.json`                        |
 
+> 🤞 On Windows (ARM64 specific?), there's some problem with codesearch's svelte packages. Skip the code search build by setting this environment variable:
+>
+> ```
+> $env:SKIP_CODE_SEARCH_BUILD="true"
+> ```
+
 ### Editor config
 
 - Install the following two IntelliJ plugins to format Java and Kotlin on file save