Skip to content

docs: contributing on Windows#2222

Merged
dunglas merged 13 commits intomainfrom
docs/contributing-windows
Mar 3, 2026
Merged

docs: contributing on Windows#2222
dunglas merged 13 commits intomainfrom
docs/contributing-windows

Conversation

@dunglas
Copy link
Member

@dunglas dunglas commented Feb 26, 2026

No description provided.

@dunglas dunglas force-pushed the docs/contributing-windows branch from 3fdfd73 to 11629d2 Compare February 26, 2026 14:51
Copy link
Contributor

@henderkes henderkes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be nice if Microsoft could merge in watcher-c support into vcpkg.

I also think we should add configuration on how to build and run the app in an IDE (e.g. GoLand). It's luckily a bit simpler on Windows than with WSL, but still not completely hands-off.

dunglas and others added 5 commits March 2, 2026 18:39
Correct grammar and punctuation throughout the document.

Signed-off-by: Kévin Dunglas <kevin@dunglas.fr>
Updated formatting and instructions for Docker and Windows development.

Signed-off-by: Kévin Dunglas <kevin@dunglas.fr>
Added instructions for installing Visual Studio, Git, Go, and vcpkg.

Signed-off-by: Kévin Dunglas <kevin@dunglas.fr>
Updated section titles for consistency and capitalization.

Signed-off-by: Kévin Dunglas <kevin@dunglas.fr>
@dunglas dunglas force-pushed the docs/contributing-windows branch from 8fb1787 to 3f3c689 Compare March 2, 2026 17:39
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds Windows-specific contributor guidance and adjusts CI to run tests with the race detector on Windows.

Changes:

  • Add a “Windows Development” section to CONTRIBUTING.md with setup, environment, test, and build steps.
  • Normalize some headings/wording in CONTRIBUTING.md (title case, punctuation/grammar tweaks).
  • Update the Windows GitHub Actions workflow test commands to attempt running with -race.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 8 comments.

File Description
CONTRIBUTING.md Adds Windows development instructions and polishes existing contributing docs.
.github/workflows/windows.yaml Modifies Windows CI test invocation to include the race detector.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

dunglas and others added 7 commits March 2, 2026 18:43
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Kévin Dunglas <kevin@dunglas.fr>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Kévin Dunglas <kevin@dunglas.fr>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Kévin Dunglas <kevin@dunglas.fr>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Kévin Dunglas <kevin@dunglas.fr>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Kévin Dunglas <kevin@dunglas.fr>
Signed-off-by: Kévin Dunglas <kevin@dunglas.fr>
Updated CGO_CFLAGS and CGO_LDFLAGS for improved paths.

Signed-off-by: Kévin Dunglas <kevin@dunglas.fr>
Updated CGO_CFLAGS to include optimization flags.

Signed-off-by: Kévin Dunglas <kevin@dunglas.fr>
@dunglas dunglas merged commit 27ff6b4 into main Mar 3, 2026
28 of 30 checks passed
@dunglas dunglas deleted the docs/contributing-windows branch March 3, 2026 19:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants