Skip to content
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.

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

x/website: add more detail about GOPATH and where to clone src code in contribution guide #67659

Open
brite107 opened this issue May 26, 2024 · 2 comments
Labels
Documentation NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.
Milestone

Comments

@brite107
Copy link

What is the URL of the page with the issue?

https://go.dev/doc/contribute#checkout_go

What is your user agent?

Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36

Screenshot

image

What did you do?

I followed the contribution guide, installed Go to ~/, and cloned the source code to ~/code/

What did you see happen?

When I open the source code to get an idea of the code before picking an issue to work on, I have some errors. I will submit a screenshot:
image
image

What did you expect to see?

I expected to open the source code and not see any errors related to installation. I would love to see some more detail in the contribution guide about where to put the go installation and the go source code. As a first contribution, I would be interested in finding the information and adding it to the documentation myself.

@gopherbot gopherbot added this to the Unreleased milestone May 26, 2024
@seankhliao seankhliao changed the title x/pkgsite: add more detail about GOPATH and where to clone src code in contribution guide x/website: add more detail about GOPATH and where to clone src code in contribution guide May 27, 2024
@seankhliao seankhliao added Documentation NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. and removed pkgsite labels May 27, 2024
@hyangah hyangah removed the website label May 30, 2024
@ansaba
Copy link

ansaba commented May 30, 2024

@dmitshur , can you check the loading error ?

@dmitshur
Copy link
Contributor

dmitshur commented May 30, 2024

The loading error happens because the main Go repository contains a development version of Go 1.23, which isn't released yet. In general, setting up gopls to work on the main Go repository is considered an advanced topic and documented in x/tools/gopls/doc/advanced.md.

I don't currently see setting up the editor discussed in the contribution guide, but perhaps something can be added under https://go.dev/doc/contribute#advanced_topics that at least links to relevant resources.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.
Projects
None yet
Development

No branches or pull requests

6 participants