contribute.html 33.8 KB
Newer Older
1
<!--{
2
	"Title": "Contribution Guide"
3
}-->
Russ Cox's avatar
Russ Cox committed
4

Russ Cox's avatar
Russ Cox committed
5
<p>
6 7 8 9
The Go project welcomes all contributors. The process of contributing
to the Go project may be different than many projects you are used to.
This document is intended as a guide to help you through the contribution
process. This guide assumes you have a basic understanding of Git and Go.
10
</p>
11 12

<p>
13 14 15
In addition to the information here, the Go community maintains a
<a href="https://golang.org/wiki/CodeReview">CodeReview</a> wiki page.
Feel free to contribute to the wiki as you learn the review process.
Russ Cox's avatar
Russ Cox committed
16 17
</p>

18
<p>
19 20
Note that the <code>gccgo</code> front end lives elsewhere;
see <a href="gccgo_contribute.html">Contributing to gccgo</a>.
21 22
</p>

23 24 25
<h2 id="contributor">Becoming a contributor</h2>

<h3>Overview</h3>
Russ Cox's avatar
Russ Cox committed
26

27
<p>
28 29 30
The first step is registering as a Go contributor and configuring your environment.
Here is a very quick checklist of the required steps, that you will need
to follow:
31 32
</p>

33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
<ul>
<li>
<b>Step 0</b>: Decide on a single Google Account you would be using to contribute to Go.
Use that account for all the following steps and make sure that <code>git</code>
is configured to create commits with that account's e-mail address.
</li>
<li>
<b>Step 1</b>: <a href="https://cla.developers.google.com/clas">Sign and submit</a> a
CLA (Contributor License Agreement).
</li>
<li>
<b>Step 2</b>: Configure authentication credentials for our <code>git</code> repository.
Go to <a href="https://go.googlesource.com/">go.googlesource.com</a>, click
on "Generate Password" (top right), and follow the instructions.
</li>
<li>
<b>Step 3</b>: Register to Gerrit, the code review tool used by the Go team, by <a href="https://go-review.googlesource.com/login/">visiting this page</a>. The CLA and the registration
need to be done only once for your account.
</li>
<li>
<b>Step 4</b>: Install <code>git-codereview</code> by running
<code>go get -u golang.org/x/review/git-codereview</code>
</li>
</ul>

58
<p>
59 60
If you prefer, we have an automated tool that walks through these steps. Just
run:
61 62 63 64 65 66 67 68 69
</p>

<pre>
$ go get -u golang.org/x/tools/cmd/go-contrib-init
$ cd /code/to/edit
$ go-contrib-init
</pre>

<p>
70 71 72
The rest of this chapter elaborates on these steps.
If you have completed the steps above (either manually or through the tool), jump to
<a href="#making_a_change">Making a change</a>.
73 74
</p>

75 76
<h3 id="google_account">Step 0: Select a Google Account</h3>

Russ Cox's avatar
Russ Cox committed
77
<p>
78 79 80 81 82 83
A contribution to Go is made through a Google account, with a specific
e-mail address. Make sure to pick one and use it throughout the process and
for all your contributions. You may need to decide whether to
use a personal address or a corporate address. The choice will depend on who
will own the copyright for the code that you will be writing
and submitting. Consider discussing this with your employer.
Russ Cox's avatar
Russ Cox committed
84 85 86
</p>

<p>
87 88 89 90
Google Accounts can either be Gmail email accounts, G-Suite organization accounts, or
accounts associated with an external e-mail address. For instance, if you need to use
an existing corporate e-mail that is not managed through G-Suite, you can create
an account associated
91 92
<a href="https://accounts.google.com/SignUpWithoutGmail">with your existing
email address</a>.
93 94
</p>

Russ Cox's avatar
Russ Cox committed
95
<p>
96 97 98 99
You also need to make sure that <code>git</code> is configured to author commits
using the same e-mail address. You can either configure it globally
(as a default for all projects), or locally (for a single specific project).
You can check the current configuration with this command:
100
<p>
Russ Cox's avatar
Russ Cox committed
101

102 103 104 105
<pre>
$ git config --global user.email  # check current global config
$ git config user.email           # check current local config
</pre>
Russ Cox's avatar
Russ Cox committed
106

107
<p>To change the configured address:</p>
108

109 110 111 112
<pre>
$ git config --global user.email name@example.com   # change global config
$ git config user.email name@example.com            # change local config
</pre>
113

114

115
<h3 id="cla">Step 1: Contributor License Agreement</h3>
116 117 118 119 120

<p>
Before sending your first change to the Go project
you must have completed one of the following two CLAs.
Which CLA you should sign depends on who owns the copyright to your work.
121 122 123 124 125 126 127 128 129 130 131

<ul>
<li>
If you are the copyright holder, you will need to agree to the
<a href="https://developers.google.com/open-source/cla/individual">individual
contributor license agreement</a>, which can be completed online.
</li>
<li>
If your organization is the copyright holder, the organization
will need to agree to the
<a href="https://developers.google.com/open-source/cla/corporate">corporate
132
contributor license agreement</a>.<br>
133 134 135 136
</li>
</ul>

<p>
137 138 139 140
You can check your currently signed agreements and sign new ones, through
the <a href="https://cla.developers.google.com/clas?pli=1&authuser=1">Google Developers
Contributor License Agreements</a> website.
If the copyright holder for your contribution has already completed the
141
agreement in connection with another Google open source project,
142
it does not need to be completed again.
143 144 145
</p>

<p>
146 147 148 149
If the copyright holder for the code you are submitting changes &mdash; for example,
if you start contributing code on behalf of a new company &mdash; please send email
to golang-dev and let us know, so that we can make sure an appropriate agreement is
completed and update the <code>AUTHORS</code> file.
150 151
</p>

152

153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
<h3 id="auth">Step 2: Configure git authentication</h3>

<p>
Go development happens on <a href="go.googlesource.com">go.googlesource.com</a>,
a <code>git</code> server hosted by Google.
Authentication on the web server is made through your Google account, but
you also need to configure <code>git</code> on your computer to access it.
Follow this steps:
</p>

<ol>
<li>
Visit <a href="https://go.googlesource.com">go.googlesource.com</a>
and click on "Generate Password" in the page's top right menu bar.
You will be redirected to accounts.google.com to sign in.
</li>
<li>
After signing in, you are taken to a page with the title "Configure Git".
This page contains a personalized script that when run locally will configure git
to have your unique authentication key.
This key is paired with one generated server side, analogous to how SSH keys work.
</li>
<li>
Copy and run this script locally in your command line terminal, to store your
secret authentication token in a <code>.gitcookies</code> file.
(On a Windows computer using <code>cmd</code> you should instead follow the instructions
in the yellow box to run the command. If you are using <code>git-bash</code> use the same
script as *nix.).
</li>
</ol>

<h3 id="auth">Step 3: Create a Gerrit account </h3>

<p>
Gerrit is an open-source tool used by Go maintainers to discuss and review
code submissions.
</p>

<p>
To register your account, visit <a href="https://go-review.googlesource.com/login/">
go-review.googlesource.com/login/</a> and sign in once using the same Google Account you used above.
</p>

<h3 id="git-codereview_install">Step 4: Install the git-codereview command</h3>

198
<p>
199 200
Changes to Go must be reviewed before they are accepted, no matter who makes the change.
A custom git command called <code>git-codereview</code>, discussed below,
201
helps to send changes to Gerrit.
202 203
</p>

204
<p>
205
Install the <code>git-codereview</code> command by running,
206 207 208
</p>

<pre>
209
$ go get -u golang.org/x/review/git-codereview
Russ Cox's avatar
Russ Cox committed
210 211
</pre>

212
<p>
213
Make sure <code>git-codereview</code> is installed in your shell path, so that the
214
<code>git</code> command can find it. Check that
Russ Cox's avatar
Russ Cox committed
215 216
</p>

217
<pre>
218
$ git codereview help
219
</pre>
220

221
<p>
222
prints help text, not an error.
223 224
</p>

225 226 227 228
<p>
On Windows, when using git-bash you must make sure that
<code>git-codereview.exe</code> is in your git exec-path.
Run <code>git --exec-path</code> to discover the right location then create a
229
symbolic link or simply copy the executable from $GOPATH/bin to this directory.
230 231
</p>

232 233 234

<h2 id="making_a_contribution">Before contributing code</h2>

235
<p>
236 237
The project welcomes submissions but please let everyone know what
you're working on if you want to change or add to the Go repositories.
238 239
</p>

240
<p>
241 242 243
Before undertaking to write something new for the Go project,
please <a href="https://golang.org/issue/new">file an issue</a>
(or claim an <a href="https://golang.org/issues">existing issue</a>).
244 245
</p>

246
<h3>Check the issue tracker</h3>
247

248 249 250 251
<p>Whether you already know what contribution to make, or you are searching for
an idea, the <a href="https://github.com/golang/go/issues">issue tracker</a> is
always the first place to go. Issues are triaged to categorize them and manage
the workflow.
252
</p>
253

254 255 256 257 258 259 260 261 262 263 264 265
<p>Most issues will be marked with one of the following workflow labels:
<ul>
	<li><b>NeedsInvestigation</b>: The issue is not fully understood well
	and requires analysis to understand the root cause. </li>
	<li><b>NeedsDecision</b>: the issue is relatively well understood, but the
	Go team hasn't yet decided the best way to fix it or implement it among all
	possible options. It would be better to wait for a decision before
	writing code. If you are interested on working on an issue in this state,
	feel free to ping maintainers here if some time has passed without a decision.</li>
	<li><b>NeedsFix</b>: the issue is fully understood and code can be written
	to fix it.</li>
</ul>
266
</p>
267

268
<h3 id="Design">Open an issue for any new problem</h3>
269

270
<p>
271 272 273 274 275 276 277
Excluding very trivial changes, all contributions should be connected
to an existing issue. Feel free to open one and discuss what your
plans are. This process gives everyone a chance to validate the design,
helps prevent duplication of effort,
and ensures that the idea fits inside the goals for the language and tools.
It also checks that the design is sound before code is written;
the code review tool is not the place for high-level discussions.
278
</p>
Russ Cox's avatar
Russ Cox committed
279 280

<p>
281 282 283 284 285
When planning work, please note that the Go project follows a <a
href="https://golang.org/wiki/Go-Release-Cycle">six-month development cycle</a>.
The latter half of each cycle is a three-month feature freeze during
which only bug fixes and doc updates are accepted. New contributions can be
sent during a feature freeze but will not be accepted until the freeze thaws.
Russ Cox's avatar
Russ Cox committed
286 287
</p>

288 289 290
<p>Significant changes must go through the
<a href="https://golang.org/s/proposal-process">change proposal process</a>
before they can be accepted.</p>
Russ Cox's avatar
Russ Cox committed
291

292
<p>
293
Sensitive security-related issues should be reported to <a href="mailto:security@golang.org">security@golang.org</a>.
Russ Cox's avatar
Russ Cox committed
294 295
</p>

296
<h2 id="making_a_contribution">Sending a change via GitHub</h2>
297 298

<p>
299 300 301 302 303
First-time contributors that are already familiar with the
<a href="https://guides.github.com/introduction/flow/">GitHub flow</a>
are encouraged to use the same process for Go contributions. Even though Go
maintainers use Gerrit for code review, a bot has been created to sync
GitHub pull requests to Gerrit.
304 305 306
</p>

<p>
307 308 309
Open a pull request as you would normally do. Gopherbot will automatically
sync the code and post a link to Gerrit. When somebody comments on the
change, it will be posted in the pull request, so you will also get a notification.
310 311
</p>

312
<p>Some things to keep in mind:
313

314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
<ul>
<li>
To update the pull request with new code, just push it to the branch; you can either
add more commits, or rebase and force-push (both styles are accepted).
</li>
<li>
If the request is accepted, all the commits will be squashed, and the final
commit description will be composed by concatenating the pull request's
title and description. The individual commits' descriptions will be discarded.
See <a href="#commit_messages">Writing good commit messages</a> for some
suggestions.
</li>
<li>
Gopherbot is unable to sync line-by-line codereview into GitHub: only the
contents of the overall comment on the request will be synced. Remember you
can always to go Gerrit to see the fine-grained review.
</li>
</ul>
332 333
</p>

334
<h2 id="making_a_contribution">Sending a change via Gerrit</h2>
335 336

<p>
337 338 339
It is not possible to fully sync Gerrit and GitHub, at least at the moment,
so we recommend learning Gerrit. It's different but powerful and familiarity
with help you understand the flow.
340 341
</p>

342
<h3>Overview</h3>
343

344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387
<p>This is an overview of the overall process:
<ul>
<li><b>Step 1:</b> Clone the Go source code from GitHub or go.googlesource.com, and make sure it's stable by compiling and testing it once:
<pre>
$ git clone https://github.com/golang/go    # or https://go.googlesource.com/go
$ cd go/src
$ ./all.bash                                # compile and test
</pre>
<li><b>Step 2:</b> Prepare changes in a new branch, created from the master branch.
To commit the changes, use <code>git</code> <code>codereview</code> <code>change</code>, that
will create or amend a single commit in the branch.
<pre>
$ git checkout -b mybranch
$ [edit files...]
$ git add [files...]
$ git codereview change   # create commit in the branch
$ [edit again...]
$ git add [files...]
$ git codereview change   # amend the existing commit with new changes
$ [etc.]
</pre>
</li>
<li>
<b>Step 3:</b> Test your changes, re-running <code>all.bash</code>.
<pre>
$ ./all.bash    # recompile and test
</pre>
</li>
<li>
<b>Step 4:</b> Send the changes for review to Gerrit using <code>git</code>
<code>codereview</code> <code>mail</code> (which doesn't use e-mail, despite the name).
<pre>
$ git codereview mail     # send changes to Gerrit
</pre>
</li>
<li>
<b>Step 5:</b> After a review, apply changes to the same single commit, and mail them to Gerrit again:
<pre>
$ [edit files...]
$ git add [files...]
$ git codereview change   # update same commit
$ git codereview mail     # send to Gerrit again
</li>
</ul>
388 389
</p>

390 391 392 393 394
<p>The rest of this chapter describes these steps in more detail.</p>


<h3 id="checkout_go">Step 1: Clone the Go source code</h3>

395
<p>
396 397 398 399
In addition to a recent Go installation, you need to have a local copy of the source
checked out from the correct repository. You should check out the Go source repo anywhere
you want as long as it's outside of your <code>GOPATH</code>. Either clone from
<code>go.googlesource.com</code> or GitHub:
400 401
</p>

402
<pre>
403
$ git clone https://github.com/golang/go   # or https://go.googlesource.com/go
404
$ cd go
405
</pre>
406

407
<h3 id="checkout_go">Step 2: Prepare changes in a new branch</h3>
408 409

<p>
410 411 412
Each Go change must be made in a separate branch, created from the master branch. You can use
the normal <code>git</code> commands to create a branch and add changes to the
staging area:
413 414 415
</p>

<pre>
416 417 418
$ git checkout -b mybranch
$ [edit files...]
$ git add [files...]
419 420
</pre>

421
<p>
422
To commit changes, instead of <code>git commit</code>, use <code>git codereview change</code>.
423 424
</p>

425 426 427 428
<pre>
$ git codereview change
(open $EDITOR)
</pre>
429 430

<p>
431 432 433 434 435
You can edit the commit description in your favorite editor as usual.
<code>git</code> <code>codereview</code> <code>change</code> will automatically
add a <code>Change-Id</code>  line near the bottom. That line is used by
Gerrit to match successive uploads of the same change. Do not edit or delete it.
This is an example:
436 437 438
</p>

<pre>
439 440 441 442 443 444 445
commit fef82cf89a34935a41bd0e3c1e0c2d9d6de29ee2 (HEAD -> test)
Author: Giovanni Bajo <rasky@develer.com>
Date:   Tue Feb 13 01:07:15 2018 +0100

    cmd/compile: test

    Change-Id: I2fbdbffb3aab626c4b6f56348861b7909e3e8990
446 447 448
</pre>

<p>
449 450 451
<code>git</code> <code>codereview</code> <code>change</code> also checks that you've
run <code>go</code> <code>fmt</code> over the source code, and that
the commit message follows the <a href="#commit_messages">suggested format</a>.
452 453
</p>

454 455 456 457 458
<p>
If you need to edit the files again, you can stage the new changes and
re-run <code>git</code> <code>codereview</code> <code>change</code>: each subsequent
run will amend the existing commit.
</p>
459 460

<p>
461 462 463 464
Make sure that you always keep a single commit in each branch. If you add more
commits by mistake, you can use <code>git</code> <code>rebase</code> to
<a href="https://stackoverflow.com/questions/31668794/squash-all-your-commits-in-one-before-a-pull-request-in-github">squash them together</a>
into a single one.
465 466
</p>

467 468

<h3 id="Testing">Step 3: Test changes</h3>
469 470

<p>
471 472 473
You've <a href="code.html">written and tested your code</a>, but
before sending code out for review, run all the tests for the whole
tree to make sure the changes don't break other packages or programs:
474 475 476
</p>

<pre>
477 478
$ cd go/src
$ ./all.bash
479 480 481
</pre>

<p>
482 483 484
(To build under Windows use <code>all.bat</code>; this also requires
setting the environment variable <code>GOROOT_BOOTSTRAP</code> to the
bootstrap compiler)
485 486
</p>

487
<p>
488
After running for a while, the command should print:
Russ Cox's avatar
Russ Cox committed
489
</p>
490

491 492 493 494 495 496 497 498 499 500 501
<pre>
"ALL TESTS PASSED".
</pre>

<p>Notice that you can use <code>make.bash</code> instead of <code>all.bash</code>
to just build the compiler without running the testsuite. Once the compiler is
built, you can run it directly from <code>&lt;GOCLONEDIR&gt;/bin/go</code>; see also
the section on <a href="#quicktest">quickly test your changes</a>.</p>

<h3 id="mail">Step 4: Send changes for review</h3>

502
<p>
503 504 505
Once the change is ready, send it for review.
This is done via the <code>mail</code> sub-command which despite its name, doesn't
directly mail anything, it just sends the change to Gerrit:
506
</p>
507

508 509 510 511
<pre>
$ git codereview mail
</pre>

512
<p>
513
Gerrit assigns your change a number and URL, which <code>git</code> <code>codereview</code> <code>mail</code> will print, something like:
514 515
</p>

Russ Cox's avatar
Russ Cox committed
516
<pre>
517 518
remote: New Changes:
remote:   https://go-review.googlesource.com/99999 math: improved Sin, Cos and Tan precision for very large arguments
Russ Cox's avatar
Russ Cox committed
519
</pre>
520

521
<p>
522 523
If you get an error instead, check the
<a href="#troubleshooting_mail">Troubleshooting mail errors</a> section.
Russ Cox's avatar
Russ Cox committed
524
</p>
525

526
<p>
527 528 529
If your change relates to an open GitHub issue and you have followed the <a href="#commit_messages">
suggested commit message format</a>, the issue will be updated in a few minutes by a bot,
linking your Gerrit change in it.
530
</p>
531

532 533 534

<h3 id="revise">Step 5: Revise changes after a review</h3>

535
<p>
536 537 538 539 540
Go maintainers will review your code on Gerrit, and you will get notifications via email.
You can see the review on Gerrit, and comment on them. You can also reply
<a href="https://gerrit-review.googlesource.com/Documentation/intro-user.html#reply-by-email">via email</a>
if you prefer.
</p>
541

542 543 544 545
<p>
When you're ready to revise your submitted code, edit the files in correct branch,
add them to the git staging area, and then amend the commit with
<code>git</code> <code>codereview</code> <code>change</code>:
546
</p>
Russ Cox's avatar
Russ Cox committed
547

548
<pre>
549 550 551
$ git codereview change     # amend current commit
(open $EDITOR)
$ git codereview mail       # send new changes to Gerrit
Russ Cox's avatar
Russ Cox committed
552 553 554
</pre>

<p>
555 556
If you don't need to change the commit description, just save and exit from the editor.
Remember not to touch the special <code>Change-Id</code> line.
Russ Cox's avatar
Russ Cox committed
557 558 559
</p>

<p>
560 561 562 563
Make sure that you always keep a single commit in each branch. If you add more
commits by mistake, you can use <code>git rebase</code> to
<a href="https://stackoverflow.com/questions/31668794/squash-all-your-commits-in-one-before-a-pull-request-in-github">squash them together</a>
into a single one.
Russ Cox's avatar
Russ Cox committed
564 565
</p>

566 567 568 569 570
<h2 id="commit_messages">Writing good commit messages</h2>

<p>Commit messages in Go follow a specific convention. Read this chapter
to learn more about it. This is an example of a good one:

Russ Cox's avatar
Russ Cox committed
571
<pre>
572
math: improve Sin, Cos and Tan precision for very large arguments
Russ Cox's avatar
Russ Cox committed
573

574 575 576
The existing implementation has poor numerical properties for
large arguments, so use the McGillicutty algorithm to improve
accuracy above 1e10.
Russ Cox's avatar
Russ Cox committed
577

578
The algorithm is described at http://wikipedia.org/wiki/McGillicutty_Algorithm
Russ Cox's avatar
Russ Cox committed
579

580
Fixes #159
Russ Cox's avatar
Russ Cox committed
581
</pre>
582 583 584
</p>

<h3>First line</h3>
Russ Cox's avatar
Russ Cox committed
585 586

<p>
587 588 589 590 591 592 593 594 595 596 597 598
The first line of the change description is conventionally a one-line
summary of the change, prefixed by the primary affected package.</p>

<p>It should be written so to complete the sentence "This change modifies Go to _____."</p>

<h3>Main content</h3>

<p>The rest of the description elaborates and should provide context for the
change and explain what it does.
Write in complete sentences with correct punctuation, just like
for your comments in Go.
If there is a helpful reference, mention it here.
599 600
</p>

601 602
<h3>Referencing issues</h3>

603 604 605
<p>
The special notation "Fixes #159" associates the change with issue 159 in the
<a href="https://golang.org/issue/159">Go issue tracker</a>.
606
When this change is eventually applied, the issue
Russ Cox's avatar
Russ Cox committed
607 608 609 610
tracker will automatically mark the issue as fixed.
</p>

<p>
611 612 613 614
If the change is a partial step towards the resolution of the issue,
uses the notation "Updates #159". This will leave a comment in the issue
linking back to the change in Gerrit, but it will not close the issue
when the change is applied.
615
</p>
Russ Cox's avatar
Russ Cox committed
616

617
<p>
618 619 620
If you are sending a change against a subrepository, you must use
the fully-qualified syntax supported by GitHub, to make sure the change is
linked to the issue in the main repository. The correct form is "Fixes golang/go#159".
621 622
</p>

623 624 625 626 627 628 629





<h2 id="review">The review process</h2>

Russ Cox's avatar
Russ Cox committed
630
<p>
631 632
This section explains the review process in details, and how to approach
reviews after a change was submitted.
Russ Cox's avatar
Russ Cox committed
633 634
</p>

635 636

<h3 id="mistakes">Common beginner mistakes</h3>
Russ Cox's avatar
Russ Cox committed
637

638
<p>
639 640 641
When a change is submitted to Gerrit, it is usually triaged in the next few days.
A maintainer will give a look and submit some initial review, that for first-time
contributors usually focus on basic cosmetics and common mistakes. For instance:
642 643
</p>

644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705
<ul>
<li>
Commit messages might not follow the <a href="#commit_messages">suggested
format</a>.
</li>
<li>
There might not be a linked GitHub issue. The vast majority of changes
require a linked issue that describes the bug or the feature that the change
fixes or implements, and consensus should have been reached on the tracker
to actually proceed with it. Gerrit reviews do not discuss the merit of the change,
just its implementation.
<br>Only very trivial or cosmetic changes will be accepted without a issue.
</li>
<li>
The change might have been submitted during the freeze phase, when the tree
is closed for some specific kind of change (eg: new features). In this case,
a maintainer might review the code with a line such as <code>R=go1.11</code>,
which means that it will be reviewed later when the tree opens for a new
development window. You can add <code>R=go1.XX</code> as a comment yourself
if you know that it's not the correct timeframe for the change and help the
maintainers.
</li>
</ul>

<h3 id="trybots">Trybots</h3>

<p>After an initial reading of your patch, maintainers will trigger trybots,
a cluster of servers that will run the full testsuite on several different
architectures. Most trybots run complete in a few minutes, and a link will
be posted in Gerrit where you can see the results.</p>

<p>If the trybot run fails, follow the link and check the full logs of the
platforms on which the tests failed. Try to understand what broke, and
update your patch. Maintainers will trigger a new trybot run to see
if the problem was fixed.</p>

<p>Sometimes, the tree can be broken on some platforms for a few hours; if
the failure in trybot logs doesn't seem related to your patch, go to the
<a href="https://build.golang.org">Build Dashboard</a> and check if the same
failures appears in the recent commits, on the same platform. In this case,
feel free to write a comment in Gerrit to mention that the failure is
unrelated to your change, to help maintainers understanding the situation.</p>

<h3 id="reviews">Reviews</h3>

<p>The Go team values very thorough reviews. Consider
each line comment like a ticket: you are expected to somehow "close" it
by acting on it, either by implementing the suggestion or convincing the
reviewer otherwise.</p>

<p>After you update the change, go through line comments and make sure
to reply on every one. You can click the "Done" button to reply
indicating that you've implemented the reviewer's suggestion; otherwise,
click on "Reply" and explain why you have not.</p>

<p>It is absolutely normal for changes to go through several round of reviews,
in which the reviewer make new comments every time and then wait for an updated
change to be uploaded. This also happens for experienced contributors, so
don't feel discouraged by it.</p>

<h3 id="votes">Voting conventions</h3>

706
<p>
707 708 709 710 711 712 713 714 715 716 717 718 719
At some point, reviewers will express a vote on your change. This is the
voting convention:
<ul>
	<li><b>+2</b> The change is approved for being merged. Only Go maintainers
	can cast a +2.</li>
	<li><b>+1</b> The change looks good, but either the reviewer is requesting
	more changes before approving it, or they are not a maintainer and cannot
	approve it, but would like to encourage an approval.</li>
	<li><b>-1</b> The change is not good the way it is. -1 are always casted
	with a comment explaining the reason for it.</li>
	<li><b>-2</b> The change is blocked by a maintainer and cannot be approved.
	There will be a comment explaining the decision.</li>
</ul>
720
</p>
721

722
<h3 id="submit">Submitting an approved change</h3>
723 724

<p>
725 726 727
After the code has been +2'ed, an approver will
apply it to the master branch using the Gerrit UI. This is
called "submission".
728 729
</p>

730
<p>
731 732 733
The two steps are separate because in some cases maintainers
may want to approve it but not to submit it right away (e.g.
the tree could be temporarily frozen).
734 735 736
</p>

<p>
737 738 739 740 741 742 743
Submission checks the change into the repository.
The change description will include a link to the code review,
and the code review will be updated with a link to the change
in the repository.
Since the method used to integrate the changes is "Cherry Pick",
the commit hashes in the repository will be changed by
the "Submit" operation.
744 745
</p>

746 747 748 749
<p>If your change has been approved for a few days without being
submitted, feel free to write a comment in Gerrit requesting
submission.</p>

750

751
<h3 id="more_information">More information</h3>
752

753
<p>
754 755 756
In addition to the information here, the Go community maintains a <a
href="https://golang.org/wiki/CodeReview">CodeReview</a> wiki page.
Feel free to contribute to this page as you learn the review process.
757 758
</p>

759

760 761

<h2 id="advanced_topics">Advanced topics</h2>
762 763

<p>
764 765
This section contains more in-depth topics on how to contribute to Go. Read it to
get a better understanding of the contribution process.
766 767
</p>

768 769 770

<h3 id="copyright">Copyright headers</h3>

771
<p>
772 773 774 775 776 777 778 779 780
Files in the Go repository don't list author names, both to avoid clutter
and to avoid having to keep the lists up to date.
Instead, your name will appear in the
<a href="https://golang.org/change">change log</a> and in the <a
href="/CONTRIBUTORS"><code>CONTRIBUTORS</code></a> file and perhaps the <a
href="/AUTHORS"><code>AUTHORS</code></a> file.
These files are automatically generated from the commit logs periodically.
The <a href="/AUTHORS"><code>AUTHORS</code></a> file defines who &ldquo;The Go
Authors&rdquo;&mdash;the copyright holders&mdash;are.
781 782
</p>

783 784
<p>New files that you contribute should use the standard copyright header:</p>

785
<pre>
786 787 788
// Copyright 2018 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
789 790
</pre>

791 792 793 794 795 796 797 798 799
<p>
Files in the repository are copyright the year they are added.
Do not update the copyright year on files that you change.
</p>




<h3 id="troubleshooting_mail">Troubleshooting mail errors</h3>
800 801

<p>
802 803 804 805
The most common way that the <code>git</code> <code>codereview</code> <code>mail</code>
command fails is because the email address in the commit does not match the one
that you used during <a href="#google_account">the registration process</a>.

806 807 808 809 810 811 812 813 814 815 816 817 818
<br>
If you see something like...
</p>

<pre>
remote: Processing changes: refs: 1, done
remote:
remote: ERROR:  In commit ab13517fa29487dcf8b0d48916c51639426c5ee9
remote: ERROR:  author email address XXXXXXXXXXXXXXXXXXX
remote: ERROR:  does not match your user account.
</pre>

<p>
819 820
You need to set this repo to use the email address that you registered with.
First, let's change the email address for this repo so this doesn't happen again.
821 822 823 824 825 826 827 828
You can change your email address for this repo with the following command:
</p>

<pre>
$ git config user.email email@address.com
</pre>

<p>
829
Then change the commit to use this alternative email address.
830 831 832 833 834 835 836 837 838 839 840 841
You can do that with:
</p>

<pre>
$ git commit --amend --author="Author Name &lt;email@address.com&gt;"
</pre>

<p>
Finally try to resend with:
</p>

<pre>
842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869
$ git codereview mail
</pre>


<h3 id="quicktest">Quickly testing your changes</h3>

<p>Running <code>all.bash</code> for every single change to the code tree
is burdensome. Even though it is strongly suggested to run it before
sending a change, during the normal development cycle you may want
to quickly compile and locally test your change.</p>

<ul>
<li>
In general, you can run <code>make.bash</code> instead of <code>all.bash</code>
to only rebuild the Go toolchain without running the whole testsuite. Or you
can run <code>run.bash</code> to only run the whole testsuite without rebuilding
the toolchain. You can think of <code>all.bash</code> as <code>make.bash</code>
followed by <code>run.bash</code>.
</li>
<li>The just-built compiler is in <code>&lt;GOCLONEDIR&gt;/bin/go</code>; you
can run it directly to test whatever you want to test. For instance, if you
have modified the compiler and you want to test how it affects the
testsuite of your own project, just run <code>go</code> <code>test</code>
using it:

<pre>
$ cd &lt;MYPROJECTDIR&gt;
$ &lt;GOCLONEDIR&gt;/bin/go test
870
</pre>
871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942
</li>

<li>
If you're changing the standard library, you probably don't need to rebuild
the compiler: you can run the tests on the package you have changed.
You can either do that with whatever Go version you normally develop with, or
using the Go compiler built from your clone (which is
sometimes required because the standard library code you're modifying
might require a newer version than the stable one you have installed).

<pre>
$ cd &lt;GOCLONEDIR&gt;/src/hash/sha1
$ [make changes...]
$ &lt;GOCLONEDIR&gt;/bin/go test .
</pre>
</li>

<li>
If you're modyfing the compiler itself, you can just recompile
the <code>compile</code> tool (which is the internal binary invoked
by <code>go</code> <code>build</code> to compile each single package).
After that, you will want to test it by compiling or running something.

<pre>
$ cd &lt;GOCLONEDIR&gt;/src
$ [make changes...]
$ &lt;GOCLONEDIR&gt;/bin/go install cmd/compile
$ &lt;GOCLONEDIR&gt;/bin/go build [something...]   # test the new compiler
$ &lt;GOCLONEDIR&gt;/bin/go run [something...]     # test the new compiler
$ &lt;GOCLONEDIR&gt;/bin/go test [something...]    # test the new compiler
</pre>

The same applies to other internal tools of the Go toolchain,
such as <code>asm</code>, <code>cover</code>, <code>link</code>,
etc. Just recompile and install the tool using <code>go</code>
<code>install</code> <code>cmd/&lt;TOOL&gt;</code> and then use
the built Go binary to test it.
</li>

<li>
In addition to the standard per-package tests, there is a top-level
testsuite in <code>&lt;GOCLONEDIR&gt;/test</code> that contains
several black-box and regression tests. The testsuite is run
by <code>all.bash</code> but you can also run it manually:

<pre>
$ cd &lt;GOCLONEDIR&gt;/test
$ go run run.go
</pre>

Note that this will use the Go compiler found in <code>PATH</code>.
</ul>

<h3 id="subrepos">Contributing to subrepositories (golang.org/x/...)</h3>

<p>
If you are contributing a change to a subrepository, obtain the
Go package using <code>go get</code>. For example, to contribute
to <code>golang.org/x/oauth2</code>, check out the code by running:
</p>

<pre>
$ go get -d golang.org/x/oauth2/...
</pre>

<p>
Then, change your directory to the package's source directory
(<code>$GOPATH/src/golang.org/x/oauth2</code>), and follow the
normal contribution flow.
</p>


943 944 945 946 947

<h3 id="cc">Specifying a reviewer / CCing others</h3>

<p>
Unless explicitly told otherwise, such as in the discussion leading
948
up to sending in the change, it's better not to specify a reviewer.
949 950 951 952 953 954 955 956 957 958 959 960 961
All changes are automatically CC'ed to the
<a href="https://groups.google.com/group/golang-codereviews">golang-codereviews@googlegroups.com</a>
mailing list. If this is your first ever change, there may be a moderation
delay before it appears on the mailing list, to prevent spam.
</p>

<p>
You can specify a reviewer or CC interested parties
using the <code>-r</code> or <code>-cc</code> options.
Both accept a comma-separated list of email addresses:
</p>

<pre>
962
$ git codereview mail -r joe@golang.org -cc mabel@example.com,math-nuts@swtch.com
963 964
</pre>

965

966

967

968

969 970


Russ Cox's avatar
Russ Cox committed
971

Dave Cheney's avatar
Dave Cheney committed
972

973
<h3 id="sync">Synchronize your client</h3>
Dave Cheney's avatar
Dave Cheney committed
974 975

<p>
976 977
While you were working, others might have submitted changes to the repository.
To update your local branch, run
978 979
</p>

Dave Cheney's avatar
Dave Cheney committed
980
<pre>
981
$ git sync
Dave Cheney's avatar
Dave Cheney committed
982 983
</pre>

Russ Cox's avatar
Russ Cox committed
984
<p>
985
(In git terms, <code>git</code> <code>sync</code> runs
986
<code>git</code> <code>pull</code> <code>-r</code>.)
Russ Cox's avatar
Russ Cox committed
987 988
</p>

989

Russ Cox's avatar
Russ Cox committed
990 991


992

993
<h3 id="download">Reviewing code by others</h3>
Russ Cox's avatar
Russ Cox committed
994 995

<p>
996 997 998 999 1000 1001 1002
As part of the review process reviewers can propose changes directly (in the
GitHub workflow this would be someone else attaching commits to a pull request).

You can import these changes proposed by someone else into your local Git repository.
On the Gerrit review page, click the "Download ▼" link in the upper right
corner, copy the "Checkout" command and run it from your local Git repo. It
should look something like this:
Russ Cox's avatar
Russ Cox committed
1003 1004
</p>

1005
<pre>
1006
$ git fetch https://go.googlesource.com/review refs/changes/21/1221/1 &amp;&amp; git checkout FETCH_HEAD
1007 1008
</pre>

Russ Cox's avatar
Russ Cox committed
1009
<p>
1010
To revert, change back to the branch you were working in.
1011
</p>
Russ Cox's avatar
Russ Cox committed
1012

1013

1014
<h3 id="git-config">Set up git aliases</h2>
Russ Cox's avatar
Russ Cox committed
1015 1016

<p>
1017 1018
The <code>git-codereview</code> command can be run directly from the shell
by typing, for instance,
Russ Cox's avatar
Russ Cox committed
1019 1020 1021
</p>

<pre>
1022
$ git codereview sync
Russ Cox's avatar
Russ Cox committed
1023 1024 1025
</pre>

<p>
1026 1027
but it is more convenient to set up aliases for <code>git-codereview</code>'s own
subcommands, so that the above becomes,
Russ Cox's avatar
Russ Cox committed
1028
</p>
Russ Cox's avatar
Russ Cox committed
1029 1030

<pre>
1031
$ git sync
Russ Cox's avatar
Russ Cox committed
1032 1033
</pre>

Russ Cox's avatar
Russ Cox committed
1034
<p>
1035 1036 1037
The <code>git-codereview</code> subcommands have been chosen to be distinct from
Git's own, so it's safe to do so. To install them, copy this text into your
Git configuration file (usually <code>.gitconfig</code> in your home directory):
Russ Cox's avatar
Russ Cox committed
1038 1039
</p>

1040
<pre>
1041 1042 1043 1044 1045 1046 1047
[alias]
	change = codereview change
	gofmt = codereview gofmt
	mail = codereview mail
	pending = codereview pending
	submit = codereview submit
	sync = codereview sync
1048 1049
</pre>

Russ Cox's avatar
Russ Cox committed
1050

1051
<h3 id="multiple_changes">Sending multiple dependent changes</h3>
Russ Cox's avatar
Russ Cox committed
1052

1053 1054 1055
<p>Gerrit allows for changes to be dependent on each other, forming a dependency chain.
This is an indication for maintainers to better review your code, even though each
change will technically need to be approved and submitted separately.</p>
1056

1057 1058
<p>To submit a group of dependent changes, keep each change as a different commit under
the same branch, and then run:
Russ Cox's avatar
Russ Cox committed
1059 1060

<pre>
1061
$ git codereview mail HEAD
Russ Cox's avatar
Russ Cox committed
1062 1063
</pre>

1064 1065
Make sure to explicitly specify <code>HEAD</code>, which is usually not required when sending
single changes.</p>