Skip to content

docs(CONTRIBUTING): Add section on how to interact with local changes#1668

Open
MagnusHJensen wants to merge 1 commit into
bwmarrin:masterfrom
MagnusHJensen:update-contributing-docs
Open

docs(CONTRIBUTING): Add section on how to interact with local changes#1668
MagnusHJensen wants to merge 1 commit into
bwmarrin:masterfrom
MagnusHJensen:update-contributing-docs

Conversation

@MagnusHJensen

Copy link
Copy Markdown
Contributor

This PR adds a new section to the CONTRIBUTING.md docs, that explains what one needs to do to verify the local changes made, the most prominent step is the replace directive, which should help out new contributors.

Some formatting changes, that my editor picked up on, which seems to just be correcting some earlier mistakes, the markdown looks the same.

@DeathHound6 DeathHound6 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another approach I've used instead of modifying go.mod, is go workspaces

$ go work init [./path/to/local/discordgo]
$ go work use [./path/to/another/local/module]

When a go workspace is created, the path to the go.work file, by default, is assigned into the GOWORK env var. This is how go knows which modules to use instead of the published remote variants
If you instead wish to use the module from go.pkg.dev, then set GOWORK=off

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants