Skip to content

docs(templates): add GOWORK=off to CONTRIBUTING-plugin template #721

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.

Sign up for GitHub

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

Merged
intel352 merged 1 commit into from
May 19, 2026
Merged

docs(templates): add GOWORK=off to CONTRIBUTING-plugin template #721

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions docs/templates/CONTRIBUTING-plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,23 @@ 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-<name>.git
cd workflow-plugin-<name>
go build ./...
go test ./...
GOWORK=off go build ./...
GOWORK=off go test ./...
```

## Pull requests

- 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

Expand Down
Loading