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