Commit 291e57f0 authored by Alberto Donizetti's avatar Alberto Donizetti

doc/contribute: fix typo and reword a few sentences

This change fixes a typo in doc/contribute.html (afects -> affects)
and rewords a few slightly akward sentences.

Change-Id: I6bfbacba0de29464fce134b0fdaf3898a97b8d57
Reviewed-on: https://go-review.googlesource.com/120105Reviewed-by: default avatarRob Pike <r@golang.org>
parent d6a27e8e
...@@ -168,7 +168,7 @@ completed and update the <code>AUTHORS</code> file. ...@@ -168,7 +168,7 @@ completed and update the <code>AUTHORS</code> file.
<h3 id="config_git_auth">Step 2: Configure git authentication</h3> <h3 id="config_git_auth">Step 2: Configure git authentication</h3>
<p> <p>
Go development happens on The main Go repository is located at
<a href="https://go.googlesource.com">go.googlesource.com</a>, <a href="https://go.googlesource.com">go.googlesource.com</a>,
a Git server hosted by Google. a Git server hosted by Google.
Authentication on the web server is made through your Google account, but Authentication on the web server is made through your Google account, but
...@@ -190,8 +190,8 @@ This key is paired with one that is generated and stored on the server, ...@@ -190,8 +190,8 @@ This key is paired with one that is generated and stored on the server,
analogous to how SSH keys work. analogous to how SSH keys work.
</li> </li>
<li> <li>
Copy and run this script locally in your command line terminal to store your Copy and run this script locally in your terminal to store your secret
secret authentication token in a <code>.gitcookies</code> file. authentication token in a <code>.gitcookies</code> file.
If you are using a Windows computer and running <code>cmd</code>, If you are using a Windows computer and running <code>cmd</code>,
you should instead follow the instructions in the yellow box to run the command; you should instead follow the instructions in the yellow box to run the command;
otherwise run the regular script. otherwise run the regular script.
...@@ -251,12 +251,13 @@ symbolic link or just copy the executable from $GOPATH/bin to this directory. ...@@ -251,12 +251,13 @@ symbolic link or just copy the executable from $GOPATH/bin to this directory.
<h2 id="before_contributing">Before contributing code</h2> <h2 id="before_contributing">Before contributing code</h2>
<p> <p>
The project welcomes submissions but to make sure things are well The project welcomes code patches, but to make sure things are well
coordinated we ask that everyone to discuss any significant changes to the coordinated you should discuss any significant change before starting
Go repositories before starting work. the work.
Best practice is to connect your work to the issue tracker, It's recommended that you signal your intention to contribute in the
either by <a href="https://golang.org/issue/new">filing a new issue</a> issue tracker, either by <a href="https://golang.org/issue/new">filing
or by claiming an <a href="https://golang.org/issues">existing issue</a>. a new issue</a> or by claiming
an <a href="https://golang.org/issues">existing one</a>.
</p> </p>
<h3>Check the issue tracker</h3> <h3>Check the issue tracker</h3>
...@@ -309,13 +310,13 @@ When planning work, please note that the Go project follows a <a ...@@ -309,13 +310,13 @@ 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>. 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 The latter half of each cycle is a three-month feature freeze during
which only bug fixes and documentation updates are accepted. which only bug fixes and documentation updates are accepted.
New contributions can be New contributions can be sent during a feature freeze, but they will
sent during a feature freeze but will not be accepted until the freeze is over. not be merged until the freeze is over.
</p> </p>
<p> <p>
Changes in general other than bug and documentation fixes Significant changes to the language, libraries, or tools must go
must go through the through the
<a href="https://golang.org/s/proposal-process">change proposal process</a> <a href="https://golang.org/s/proposal-process">change proposal process</a>
before they can be accepted. before they can be accepted.
</p> </p>
...@@ -337,10 +338,11 @@ GitHub pull requests to Gerrit. ...@@ -337,10 +338,11 @@ GitHub pull requests to Gerrit.
<p> <p>
Open a pull request as you normally would. Open a pull request as you normally would.
Gopherbot will automatically Gopherbot will create a corresponding Gerrit change and post a link to
sync the code and post a link to Gerrit. it on your GitHub pull request; updates to the pull request will also
When somebody comments on the get reflected in the Gerrit change.
change, it will be posted in the pull request, so you will also get a notification. When somebody comments on the change, their comment will be also
posted in your pull request, so you will get a notification.
</p> </p>
<p> <p>
...@@ -545,7 +547,7 @@ ALL TESTS PASSED ...@@ -545,7 +547,7 @@ ALL TESTS PASSED
<p> <p>
You can use <code>make.bash</code> instead of <code>all.bash</code> You can use <code>make.bash</code> instead of <code>all.bash</code>
to just build the compiler and standard packages without running the test suite. to just build the compiler and the standard library without running the test suite.
Once the <code>go</code> tool is built, it will be installed as <code>bin/go</code> Once the <code>go</code> tool is built, it will be installed as <code>bin/go</code>
under the directory in which you cloned the Go repository, and you can under the directory in which you cloned the Go repository, and you can
run it directly from there. run it directly from there.
...@@ -597,8 +599,9 @@ if you prefer. ...@@ -597,8 +599,9 @@ if you prefer.
</p> </p>
<p> <p>
If you need to revise your change after the review, edit the files in correct branch, If you need to revise your change after the review, edit the files in
add them to the Git staging area, and then amend the commit with the same branch you previously created, add them to the Git staging
area, and then amend the commit with
<code>git</code> <code>codereview</code> <code>change</code>: <code>git</code> <code>codereview</code> <code>change</code>:
</p> </p>
...@@ -674,7 +677,7 @@ Don't use HTML, Markdown, or any other markup language. ...@@ -674,7 +677,7 @@ Don't use HTML, Markdown, or any other markup language.
<p> <p>
Add any relevant information, such as benchmark data if the change Add any relevant information, such as benchmark data if the change
afects performance. affects performance.
The <a href="https://godoc.org/golang.org/x/tools/cmd/benchcmp">benchcmp</a> The <a href="https://godoc.org/golang.org/x/tools/cmd/benchcmp">benchcmp</a>
tool is conventionally used to format tool is conventionally used to format
benchmark data for change descriptions. benchmark data for change descriptions.
...@@ -937,7 +940,7 @@ remote: ERROR: does not match your user account. ...@@ -937,7 +940,7 @@ remote: ERROR: does not match your user account.
<p> <p>
you need to configure Git for this repository to use the you need to configure Git for this repository to use the
e-mail address that you registered with. e-mail address that you registered with.
To change the e-mail address for this doesn't happen again, run: To change the e-mail address to ensure this doesn't happen again, run:
</p> </p>
<pre> <pre>
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment