Skip to content

Commit 19e27c7

Browse files
committed
doc: discuss copyright changes in contribute.html
Fixes #12542. Change-Id: Icd0fa84d891d6b1feab9b4d4dd319cdf1e6d6c48 Reviewed-on: https://go-review.googlesource.com/18336 Reviewed-by: Brad Fitzpatrick <[email protected]>
1 parent b598a7f commit 19e27c7

File tree

1 file changed

+22
-15
lines changed

1 file changed

+22
-15
lines changed

doc/contribute.html

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ <h2 id="Code_review">Code review</h2>
8181
system called <a href="https://code.google.com/p/gerrit/">Gerrit</a>.
8282
</p>
8383

84-
<h3>Set up authentication for code review</h3>
84+
<h3 id="auth">Set up authentication for code review</h3>
8585

8686
<p>
8787
Gerrit uses Google Accounts for authentication. If you don't have
@@ -120,7 +120,7 @@ <h3>Set up authentication for code review</h3>
120120
and Git is configured to use this file.
121121
</p>
122122

123-
<h3>Register with Gerrit</h3>
123+
<h3 id="gerrit">Register with Gerrit</h3>
124124

125125
<p>
126126
Now that you have your authentication token,
@@ -132,7 +132,7 @@ <h3>Register with Gerrit</h3>
132132
That is all that is required.
133133
</p>
134134

135-
<h3>Contributor License Agreement</h3>
135+
<h3 id="cla">Contributor License Agreement</h3>
136136

137137
<p>Gerrit serves as the gatekeeper and uses your e-mail address as the key.
138138
To send your first change to the Go project from a given address,
@@ -167,7 +167,14 @@ <h3>Contributor License Agreement</h3>
167167
This rigmarole only needs to be done for your first submission for each email address.
168168
</p>
169169

170-
<h3>Install the git-codereview command</h3>
170+
<p>
171+
If the copyright holder for the code you are submitting changes—for example,
172+
if you start contributing code on behalf of a new company—please send email
173+
to let us know, so that we can make sure an appropriate agreement is completed
174+
and update the <code>AUTHORS</code> file.
175+
</p>
176+
177+
<h3 id="git-codereview">Install the git-codereview command</h3>
171178

172179
<p>
173180
Now install the <code>git-codereview</code> command by running,
@@ -201,7 +208,7 @@ <h3>Install the git-codereview command</h3>
201208
checkout by running <code>git-codereview</code> <code>hooks</code>.
202209
</p>
203210

204-
<h3>Set up git aliases</h3>
211+
<h3 id="git-config">Set up git aliases</h3>
205212

206213
<p>
207214
The <code>git-codereview</code> command can be run directly from the shell
@@ -243,7 +250,7 @@ <h3>Set up git aliases</h3>
243250
sync = codereview sync
244251
</pre>
245252

246-
<h3>Understanding the git-codereview command</h3>
253+
<h3 id="help">Understanding the git-codereview command</h3>
247254

248255
<p>After installing the <code>git-codereview</code> command, you can run</p>
249256

@@ -256,7 +263,7 @@ <h3>Understanding the git-codereview command</h3>
256263
You can also read the <a href="https://godoc.org/golang.org/x/review/git-codereview">command documentation</a>.
257264
</p>
258265

259-
<h3>Switch to the master branch</h3>
266+
<h3 id="master">Switch to the master branch</h3>
260267

261268
<p>
262269
Most Go installations use a release branch, but new changes should
@@ -276,7 +283,7 @@ <h3>Switch to the master branch</h3>
276283
<code>git</code> <code>pull</code> <code>-r</code>.)
277284
</p>
278285

279-
<h3>Make a change</h3>
286+
<h3 id="change">Make a change</h3>
280287

281288
<p>
282289
The entire checked-out tree is writable.
@@ -405,7 +412,7 @@ <h3>Make a change</h3>
405412
runs <code>git</code> <code>commit</code> <code>--amend</code>.)
406413
</p>
407414

408-
<h3>Mail the change for review</h3>
415+
<h3 id="mail">Mail the change for review</h3>
409416

410417
<p>
411418
Once the change is ready, mail it out for review:
@@ -455,7 +462,7 @@ <h3>Mail the change for review</h3>
455462
remote: https://go-review.googlesource.com/99999 math: improved Sin, Cos and Tan precision for very large arguments
456463
</pre>
457464

458-
<h3>Reviewing code</h3>
465+
<h3 id="review">Reviewing code</h3>
459466

460467
<p>
461468
Running <code>git</code> <code>mail</code> will send an email to you and the
@@ -467,7 +474,7 @@ <h3>Reviewing code</h3>
467474
(Unlike with the old Rietveld review system, replying by mail has no effect.)
468475
</p>
469476

470-
<h3>Revise and upload</h3>
477+
<h3 id="revise">Revise and upload</h3>
471478

472479
<p>
473480
You must respond to review comments through the web interface.
@@ -494,7 +501,7 @@ <h3>Revise and upload</h3>
494501
<code>change</code> <code><i>&lt;branch&gt;</i></code>.
495502
</p>
496503

497-
<h3>Synchronize your client</h3>
504+
<h3 id="sync">Synchronize your client</h3>
498505

499506
<p>
500507
While you were working, others might have submitted changes to the repository.
@@ -612,7 +619,7 @@ <h3>Synchronize your client</h3>
612619
restore the change commit.
613620
</p>
614621

615-
<h3>Reviewing code by others</h3>
622+
<h3 id="download">Reviewing code by others</h3>
616623

617624
<p>
618625
You can import a change proposed by someone else into your local Git repository.
@@ -629,7 +636,7 @@ <h3>Reviewing code by others</h3>
629636
To revert, change back to the branch you were working in.
630637
</p>
631638

632-
<h3>Submit the change after the review</h3>
639+
<h3 id="submit">Submit the change after the review</h3>
633640

634641
<p>
635642
After the code has been <code>LGTM</code>'ed, an approver may
@@ -648,7 +655,7 @@ <h3>Submit the change after the review</h3>
648655
the submit operation.
649656
</p>
650657

651-
<h3>More information</h3>
658+
<h3 id="more">More information</h3>
652659

653660
<p>
654661
In addition to the information here, the Go community maintains a <a href="https://golang.org/wiki/CodeReview">CodeReview</a> wiki page.

0 commit comments

Comments
 (0)