Skip to content

Enable contributions from Windows developers #139

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.

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

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

ScottArbeit
Copy link

This PR adds support for Windows developers to contribute to the project. It includes PowerShell-equivalent scripts the bash scripts that set up prerequisites and dependencies, as well as a Windows-specific Makefile that uses PowerShell to execute its steps.

@Copilot Copilot AI review requested due to automatic review settings April 2, 2025 18:15
@ScottArbeit ScottArbeit requested a review from a team as a code owner April 2, 2025 18:15
Copy link

@Copilot 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

This PR enables Windows developers to contribute to the project by updating the contribution guidelines.

  • Updated dependency installation instructions with platform-specific commands.
  • Added separate commands for running tests on Unix-like and Windows systems.
Files not reviewed (4)
  • Makefile.win: Language not supported
  • script/bootstrap.ps1: Language not supported
  • script/ensure-go-installed.ps1: Language not supported
  • script/go.ps1: Language not supported

Tip: If you use Visual Studio Code, you can request a review from Copilot before you push from the "Source Control" tab. Learn more

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@ScottArbeit
Copy link
Author

cc: @ttaylorr

Copy link
Member

@mhagger mhagger left a comment

Choose a reason for hiding this comment

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

I can't vet the code, but I like the sentiment!

I left one comment, more out of curiosity than as an informed suggestion. BTW two of the new files are missing a trailing EOL on their last lines.

Makefile.win Outdated

# Help target
help:
@powershell -NoProfile -ExecutionPolicy Bypass -Command "Write-Host 'Windows Makefile for git-sizer' -ForegroundColor Cyan"
Copy link
Member

Choose a reason for hiding this comment

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

Is there an easier way to make powershell be used for all commands rather than having to write them all out like this? Glancing at the GNU make docs, maybe setting MAKESHELL would do something like that?

Copy link
Author

Choose a reason for hiding this comment

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

Thanks for the pointer... just cleaned that up with a variable.

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.

2 participants