docs(templates): add GOWORK=off to CONTRIBUTING-plugin template#721
Merged
Conversation
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) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the external plugin CONTRIBUTING template to explicitly disable Go workspaces during common build/test/vet commands, preventing accidental use of a parent go.work when contributors have multiple GoCodeAlone repos checked out together.
Changes:
- Add a short explanation of when/why to use
GOWORK=offin local plugin development. - Prefix
go build,go test, andgo vetinstructions withGOWORK=off.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
⏱ Benchmark Results✅ No significant performance regressions detected. benchstat comparison (baseline → PR)
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
GOWORK=offprefix togo build/go test/go vetcommands indocs/templates/CONTRIBUTING-plugin.mdso new external contributors with a multi-repo workspace don't hit the upstreamgo.workshort-circuit.Test plan
🤖 Generated with Claude Code