Pkg.go.dev is part of the Go open source project. We would love to receive your contributions!
Since we are actively working on the site, we ask that you file an issue and claim it before starting to work on something. Otherwise, it is likely that we might already be working on a fix for your issue.
All issues related to x/pkgsite are labeled with the
In particular, we would love your help on issues tagged with the
help wanted label.
If this is your first time contributing to x/pkgsite, take a look at the
Suggested issues for a good first issue.
Before you begin working on an issue, please leave a comment that you are claiming it.
Complete the steps in the Go Contribution Guide.
Download the source code for x/pkgsite:
git clone https://go.googlesource.com/pkgsite NOTE: You will need Go 1.18 (as of this writing, the beta2 release) to develop pkgsite.
Review the design document.
If you are contributing a CSS change, please review the Go CSS Coding Guidelines.
There are two ways to run pkg.go.dev locally.
Use a proxy service as a datasource.
Use postgres as the datasource.
See doc/frontend.md for details.
You can use the
GO_DISCOVERY_LOG_LEVEL environment variable to set the log level. All logs below the level that is set will not be printed.
For example, setting
GO_DISCOVERY_LOG_LEVEL=info will not print
Debug logs, but it will print
The supported levels are
By default, logs for all levels will be printed.
./all.bashand fix all resulting errors. See doc/precommit.md for instructions on setting up a pre-commit hook.
After addressing code review comments, mark each comment as:
If a CL is in progress, but you want to push the intermediate state, it is helpful to mark the CL as “work in progress”. You can do this using the three-dot menu at top right corner, and clicking
Mark as work in progress. Please do this to indicate to the reviewer(s) that a CL isn’t ready for review.
If you are interested in contributing and have questions, come talk to us in the #pkgsite channel on the Gophers Slack!