Skip to content

Commit

Permalink
_content/doc: GOPATH and gopls instructions in contribution guide
Browse files Browse the repository at this point in the history
Fixes golang/go#67659

Change-Id: I01b22c68049f89694513185ac9076e4fa8d94114
Reviewed-on: https://go-review.googlesource.com/c/website/+/598095
Reviewed-by: Ian Lance Taylor <iant@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Auto-Submit: Ian Lance Taylor <iant@golang.org>
Reviewed-by: Cherry Mui <cherryyz@google.com>
Commit-Queue: Ian Lance Taylor <iant@golang.org>
  • Loading branch information
seankhliao authored and gopherbot committed Jul 17, 2024
1 parent 874627b commit 5c2e333
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion _content/doc/contribute.html
Original file line number Diff line number Diff line change
Expand Up @@ -537,7 +537,8 @@ <h3 id="checkout_go">Step 1: Clone the source code</h3>
In addition to a recent Go installation, you need to have a local copy of the source
checked out from the correct repository.
You can check out the Go source repo onto your local file system anywhere
you want as long as it's outside your <code>GOPATH</code>.
you want as long as it's outside your <code>GOPATH</code>
(defaults to the directory <code>go</code> in your home directory).
Clone from <code>go.googlesource.com</code> (not GitHub):
</p>

Expand Down Expand Up @@ -1018,6 +1019,17 @@ <h2 id="advanced_topics">Miscellaneous topics</h2>
outside the issue/edit/code review/submit process itself.
</p>

<h3 id="gopls">Gopls</h3>

<p>
When working on the main Go repository and using <code>gopls</code> with your editor,
the <code>go</code> command invoked by <code>gopls</code>
must correspond to the version of the source code you are working on.
The <code>go</code> command can be built with <code>make.bash</code>
and the <code>bin</code> directory should be added to your <code>PATH</code>.
See <a href="https://go.googlesource.com/tools/+/refs/heads/master/gopls/doc/advanced.md">
Gopls: Advanced topics</a> for additional details.
</p>

<h3 id="copyright">Copyright headers</h3>

Expand Down

0 comments on commit 5c2e333

Please sign in to comment.