Skip to content

Commit

Permalink
doc: discuss copyright changes in contribute.html
Browse files Browse the repository at this point in the history
Fixes #12542.

Change-Id: Icd0fa84d891d6b1feab9b4d4dd319cdf1e6d6c48
Reviewed-on: https://go-review.googlesource.com/18336
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
  • Loading branch information
rsc committed Jan 6, 2016
1 parent b598a7f commit 19e27c7
Showing 1 changed file with 22 additions and 15 deletions.
37 changes: 22 additions & 15 deletions doc/contribute.html
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ <h2 id="Code_review">Code review</h2>
system called <a href="https://code.google.com/p/gerrit/">Gerrit</a>.
</p>

<h3>Set up authentication for code review</h3>
<h3 id="auth">Set up authentication for code review</h3>

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

<h3>Register with Gerrit</h3>
<h3 id="gerrit">Register with Gerrit</h3>

<p>
Now that you have your authentication token,
Expand All @@ -132,7 +132,7 @@ <h3>Register with Gerrit</h3>
That is all that is required.
</p>

<h3>Contributor License Agreement</h3>
<h3 id="cla">Contributor License Agreement</h3>

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

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

<h3 id="git-codereview">Install the git-codereview command</h3>

<p>
Now install the <code>git-codereview</code> command by running,
Expand Down Expand Up @@ -201,7 +208,7 @@ <h3>Install the git-codereview command</h3>
checkout by running <code>git-codereview</code> <code>hooks</code>.
</p>

<h3>Set up git aliases</h3>
<h3 id="git-config">Set up git aliases</h3>

<p>
The <code>git-codereview</code> command can be run directly from the shell
Expand Down Expand Up @@ -243,7 +250,7 @@ <h3>Set up git aliases</h3>
sync = codereview sync
</pre>

<h3>Understanding the git-codereview command</h3>
<h3 id="help">Understanding the git-codereview command</h3>

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

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

<h3>Switch to the master branch</h3>
<h3 id="master">Switch to the master branch</h3>

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

<h3>Make a change</h3>
<h3 id="change">Make a change</h3>

<p>
The entire checked-out tree is writable.
Expand Down Expand Up @@ -405,7 +412,7 @@ <h3>Make a change</h3>
runs <code>git</code> <code>commit</code> <code>--amend</code>.)
</p>

<h3>Mail the change for review</h3>
<h3 id="mail">Mail the change for review</h3>

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

<h3>Reviewing code</h3>
<h3 id="review">Reviewing code</h3>

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

<h3>Revise and upload</h3>
<h3 id="revise">Revise and upload</h3>

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

<h3>Synchronize your client</h3>
<h3 id="sync">Synchronize your client</h3>

<p>
While you were working, others might have submitted changes to the repository.
Expand Down Expand Up @@ -612,7 +619,7 @@ <h3>Synchronize your client</h3>
restore the change commit.
</p>

<h3>Reviewing code by others</h3>
<h3 id="download">Reviewing code by others</h3>

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

<h3>Submit the change after the review</h3>
<h3 id="submit">Submit the change after the review</h3>

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

<h3>More information</h3>
<h3 id="more">More information</h3>

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

0 comments on commit 19e27c7

Please sign in to comment.