blob: e6a556b06e2129efd40767dd438643e1166b702e [file] [log] [blame] [view]
Andrew Gerrandb084b752015-02-19 07:58:37 +11001# Contributing to Go
2
3Go is an open source project.
4
5It is the work of hundreds of contributors. We appreciate your help!
6
7
8## Filing issues
9
10When [filing an issue](https://golang.org/issue/new), make sure to answer these five questions:
11
121. What version of Go are you using (`go version`)?
132. What operating system and processor architecture are you using?
143. What did you do?
154. What did you expect to see?
165. What did you see instead?
17
18General questions should go to the [golang-nuts mailing list](https://groups.google.com/group/golang-nuts) instead of the issue tracker.
19The gophers there will answer or ask you to file an issue if you've tripped over a bug.
20
Katrina Owenbcf61da2015-10-15 22:37:01 -060021## Verifying changes during development
22
23In order to verify changes to the slides or code examples while developing
24locally compile with your local toolchain:
25
26 $ go install golang.org/x/tour/gotour
27 $ $GOPATH/bin/gotour
28
Katrina Owen6a3e29c2015-10-08 21:33:05 -060029## Running the App Engine version locally
30
Katrina Owenbcf61da2015-10-15 22:37:01 -060031To view the App Engine version of the slides while developing locally, install
32the [Go App Engine SDK](https://cloud.google.com/appengine/downloads?hl=en)
33and then:
Katrina Owen6a3e29c2015-10-08 21:33:05 -060034
35 $ cd $GOPATH/src/golang.org/x/tour
36 $ $SDK_PATH/dev_appserver.py .
37
Katrina Owenbcf61da2015-10-15 22:37:01 -060038The App Engine version runs code examples against the service at play.golang.org.
39To verify changes to the code examples you must use your local toolchain to compile
40and run `gotour` locally.
41
Andrew Gerrandb084b752015-02-19 07:58:37 +110042## Contributing code
43
44Please read the [Contribution Guidelines](https://golang.org/doc/contribute.html)
45before sending patches.
46
47**We do not accept GitHub pull requests**
48(we use [Gerrit](https://code.google.com/p/gerrit/) instead for code review).
49
50Unless otherwise noted, the Go source files are distributed under
51the BSD-style license found in the LICENSE file.
52