Skip to content

docs: modify contributing to exclude Windows for action rebuild #1669

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mschile merged 1 commit into from
Mar 1, 2026
+9 −1
Merged

docs: modify contributing to exclude Windows for action rebuild #1669

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading