diff options
author | Alberto Donizetti <alb.donizetti@gmail.com> | 2018-06-20 19:23:24 +0200 |
---|---|---|
committer | Alberto Donizetti <alb.donizetti@gmail.com> | 2018-06-24 16:01:45 +0000 |
commit | 291e57f057c480889be3cc7abf83698f8c6646ba (patch) | |
tree | 6ce68cb5033699aab5875711a2034bf88ec8e0f2 /doc/contribute.html | |
parent | d6a27e8edcd992b36446c5021a3c7560d983e9a6 (diff) | |
download | go-git-291e57f057c480889be3cc7abf83698f8c6646ba.tar.gz |
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/120105
Reviewed-by: Rob Pike <r@golang.org>
Diffstat (limited to 'doc/contribute.html')
-rw-r--r-- | doc/contribute.html | 47 |
1 files changed, 25 insertions, 22 deletions
diff --git a/doc/contribute.html b/doc/contribute.html index c5339613a8..388016fac0 100644 --- a/doc/contribute.html +++ b/doc/contribute.html @@ -168,7 +168,7 @@ completed and update the <code>AUTHORS</code> file. <h3 id="config_git_auth">Step 2: Configure git authentication</h3> <p> -Go development happens on +The main Go repository is located at <a href="https://go.googlesource.com">go.googlesource.com</a>, a Git server hosted by Google. 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, 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. +Copy and run this script locally in your terminal to store your secret +authentication token in a <code>.gitcookies</code> file. 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; otherwise run the regular script. @@ -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> <p> -The project welcomes submissions but to make sure things are well -coordinated we ask that everyone to discuss any significant changes to the -Go repositories before starting work. -Best practice is to connect your work to the issue tracker, -either by <a href="https://golang.org/issue/new">filing a new issue</a> -or by claiming an <a href="https://golang.org/issues">existing issue</a>. +The project welcomes code patches, but to make sure things are well +coordinated you should discuss any significant change before starting +the work. +It's recommended that you signal your intention to contribute in the +issue tracker, either by <a href="https://golang.org/issue/new">filing +a new issue</a> or by claiming +an <a href="https://golang.org/issues">existing one</a>. </p> <h3>Check the issue tracker</h3> @@ -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>. The latter half of each cycle is a three-month feature freeze during which only bug fixes and documentation updates are accepted. -New contributions can be -sent during a feature freeze but will not be accepted until the freeze is over. +New contributions can be sent during a feature freeze, but they will +not be merged until the freeze is over. </p> <p> -Changes in general other than bug and documentation fixes -must go through the +Significant changes to the language, libraries, or tools must go +through the <a href="https://golang.org/s/proposal-process">change proposal process</a> before they can be accepted. </p> @@ -337,10 +338,11 @@ GitHub pull requests to Gerrit. <p> Open a pull request as you normally would. -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. +Gopherbot will create a corresponding Gerrit change and post a link to +it on your GitHub pull request; updates to the pull request will also +get reflected in the Gerrit change. +When somebody comments on the change, their comment will be also +posted in your pull request, so you will get a notification. </p> <p> @@ -545,7 +547,7 @@ ALL TESTS PASSED <p> 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> under the directory in which you cloned the Go repository, and you can run it directly from there. @@ -597,8 +599,9 @@ if you prefer. </p> <p> -If you need to revise your change after the review, edit the files in correct branch, -add them to the Git staging area, and then amend the commit with +If you need to revise your change after the review, edit the files in +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>: </p> @@ -674,7 +677,7 @@ Don't use HTML, Markdown, or any other markup language. <p> 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> tool is conventionally used to format benchmark data for change descriptions. @@ -937,7 +940,7 @@ remote: ERROR: does not match your user account. <p> you need to configure Git for this repository to use the 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> <pre> |