|author||Dmitri Shuralyov <email@example.com>||Fri May 08 09:55:00 2020 -0400|
|committer||Dmitri Shuralyov <firstname.lastname@example.org>||Fri May 08 15:55:07 2020 +0000|
pic: document package Effective Go¹ says every package should have a package comment, and every exported name in a package should have a doc comment. This package is mentioned in the Go tour. Let's set a good example. ¹ https://golang.org/doc/effective_go.html#commentary Change-Id: Iac561c7530fc49d5ff17c51d925151ec8319ef24 Reviewed-on: https://go-review.googlesource.com/c/tour/+/232865 Run-TryBot: Dmitri Shuralyov <email@example.com> TryBot-Result: Gobot Gobot <firstname.lastname@example.org> Reviewed-by: Alexander Rakoczy <email@example.com>
A Tour of Go is an introduction to the Go programming language. Visit https://tour.golang.org to start the tour.
To install the tour from source, first install Go and then run:
$ go get golang.org/x/tour
This will place a
tour binary in your workspace's
bin directory. The tour program can be run offline.
Contributions should follow the same procedure as for the Go project: https://golang.org/doc/contribute.html
To run the tour server locally:
go run .
Your browser should now open. If not, please visit http://localhost:3999/.
This repository uses Gerrit for code changes. To learn how to submit changes to this repository, see https://golang.org/doc/contribute.html.
The issue tracker for the tour's code is located at https://github.com/golang/go/issues. Prefix your issue with “x/tour:” in the subject line, so it is easy to find.
Issues with the tour's content itself should be reported in the issue tracker at https://github.com/golang/tour/issues.
To deploy tour.golang.org, run:
GO111MODULE=on gcloud --project=golang-org app deploy --no-promote app.yaml
This will create a new version, which can be viewed within the golang-org GCP project.
Check that the deployed version looks OK (click the version link in GCP).
If all is well, click “Migrate Traffic” to move 100% of the tour.golang.org traffic to the new version.
Unless otherwise noted, the go-tour source files are distributed under the BSD-style license found in the LICENSE file.