From 8913a598164786b69b5060575b5d78be07ca273a Mon Sep 17 00:00:00 2001
From: Mike McCready <66998419+MikeMcC399@users.noreply.github.com>
Date: Sun, 1 Mar 2026 12:53:11 +0100
Subject: [PATCH] docs: modify contributing to exclude Windows for action
 rebuild

---
 CONTRIBUTING.md | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index aec37258d..b4a9d4193 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -75,7 +75,15 @@ To contribute changes, follow these instructions in the order given below:
 
 #### Windows users
 
-The repository is set up with a `git` / `Husky` pre-commit hook which ensures that any changes to the core source files are formatted and built consistently before they are committed. This does not work well with [GitHub Desktop](https://docs.github.com/en/desktop). You can disable this function by setting an environment variable `HUSKY=0`. If you do this and then omit to use `npm run format` / `npm run build` before you commit any changes affecting the core source files, you will find that checks fail when you submit a PR. In this case you should run the `format` and `build` commands and amend your commit.
+Rebuilding the action with `npm run build` produces different results under Windows compared to Ubuntu.
+This means that Windows cannot be used to rebuild the action,
+because the workflow [check-dist.yml](./.github/workflows/check-dist.yml), running under `ubuntu-24.04`,
+will fail for action content in the [dist](./dist/) directory built under Windows.
+
+The repository is set up with a `git` / `Husky` pre-commit hook which is intended to ensure that any changes
+to the core source files are formatted and built consistently before they are committed.
+Since this is not relevant for Windows, you can disable this function by setting an environment variable `HUSKY=0`.
+You can alternatively use `git commit` with `--no-verify` to bypass the pre-commit hook from `Husky` when working on Windows.
 
 ### Adding a new example