Contributing to pkg.go.dev

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.

Because we are currently working on a redesign of pkg.go.dev, we will not be accepting any contributions for issues with a UX label.

Please read the Contribution Guidelines before sending patches.

Finding issues

All issues are labeled with the go.dev label. Issues that are suitable for contributors are additionally tagged with the help wanted label.

Before you begin working on an issue, please leave a comment that you are claiming it.

Getting started

  1. Get the source code:

$ git clone https://go.googlesource.com/pkgsite

  1. Review the design document.

  2. We deploy to the Google Cloud Platform. If you wish to set up a similar environment, you will want to download and install the Google Cloud SDK at https://cloud.google.com/sdk/docs/.

  3. If you are planning to develop any feature that involves the database, you will need to set up and populate your local database. To run the frontend and server servers locally, see the documentation for the frontend server and worker server.

  4. Depending on the feature you are working on, review the contributing guides for:

Questions

You can find us in the #tools channel on the Gophers Slack, or you can send us an email at go-discovery-feedback@google.com.