Skip to content

Latest commit

 

History

History
30 lines (18 loc) · 2.3 KB

CONTRIBUTING.md

File metadata and controls

30 lines (18 loc) · 2.3 KB

Contributing

Contributions are welcome.

Development

test -z "$(gofmt -l cmd internal)"
go vet ./...
go test -race ./...
nix flake check

Keep changes focused and add tests for behavior. Do not add analytics, background network calls, credential output, or persistent identifiers without an explicit design decision and documentation.

CI runners

Linux CI and release jobs use Blacksmith Ubuntu 24.04 runners, with native ARM64 runners for ARM64 releases and package checks. Apple Silicon macOS jobs use Blacksmith macOS 15. Intel macOS builds and Homebrew checks remain on GitHub's native Intel runners because Blacksmith supports only ARM64 macOS. The Blacksmith GitHub App must have access to this repository for jobs to be provisioned. Build with Go 1.26; scripts/build.sh retains the existing archive target names and disables cgo.

Windows x64 jobs use GitHub's windows-2025 runner. scripts/test-windows.ps1 builds the Go CLI and test executable, runs tests under a fresh standard-user profile and probes cross-identity config access. It creates temporary local accounts and is intended for an ephemeral elevated CI runner. scripts/test-windows-managers.ps1 runs real Scoop, WinGet and Chocolatey install/fixture-upgrade/uninstall checks from the exact built ZIP. These native checks gate release publication; retain actual run URLs and source/artifact identities with verification results.

For local Windows development, install Go 1.26 and Git for Windows, then run go vet ./... and go test ./... from a standard-user shell. No C or Rust toolchain is needed. Review branches named review/windows-*, pull requests and workflow dispatch trigger CI without creating a release.

Compatibility

Release targets are listed in the README and installation guide. Windows work targets native x64 (x86_64-pc-windows-msvc). Keep Unix permissions and Windows current-user ACLs equally restrictive, preserve configuration overrides and agent/human credential boundaries, and exercise executable resolution through actual native executables. Cross-compilation and generated package fixtures are useful checks, but do not establish native runtime or manager lifecycle success.

Security changes

Use the private process in SECURITY.md instead of opening a pull request that demonstrates an exploitable vulnerability.