From a4a89138ddb70fef3f94b7f5e4e35dfc7431b4a8 Mon Sep 17 00:00:00 2001 From: Jon Langevin Date: Tue, 19 May 2026 14:18:50 -0400 Subject: [PATCH] docs(templates): add GOWORK=off to CONTRIBUTING-plugin.md build commands MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Plugin contributors with a multi-repo workspace (GoCodeAlone has a top-level go.work file linking workflow + plugins + ratchet + modular) hit inconsistent build failures unless GOWORK=off is set. Document it explicitly in the per-plugin CONTRIBUTING template so the local-dev quickstart works for new external contributors. Per-plugin CONTRIBUTING.md files were generated from this template during the 2026-05-19 multi-repo QoL sweep — follow-up PRs propagate this update to each plugin repo's copy. Co-Authored-By: Claude Opus 4.7 (1M context) --- docs/templates/CONTRIBUTING-plugin.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/templates/CONTRIBUTING-plugin.md b/docs/templates/CONTRIBUTING-plugin.md index b01af914..abedabf5 100644 --- a/docs/templates/CONTRIBUTING-plugin.md +++ b/docs/templates/CONTRIBUTING-plugin.md @@ -8,11 +8,15 @@ Read the [upstream CONTRIBUTING.md](https://github.com/GoCodeAlone/workflow/blob ## Local development +If you have a `go.work` file in a parent directory (common when working on +multiple GoCodeAlone repos side-by-side), use `GOWORK=off` so the plugin +builds against its own pinned `go.mod` rather than the workspace. + ```sh git clone https://github.com/GoCodeAlone/workflow-plugin-.git cd workflow-plugin- -go build ./... -go test ./... +GOWORK=off go build ./... +GOWORK=off go test ./... ``` ## Pull requests @@ -20,7 +24,7 @@ go test ./... - One feature or bugfix per PR. - Update CHANGELOG.md with a Keep-a-Changelog entry. - Add tests covering new behavior. -- Run `go vet ./...` before pushing. +- Run `GOWORK=off go vet ./...` before pushing. ## Reporting issues