From: Alberto Donizetti Date: Wed, 20 Jun 2018 17:23:24 +0000 (+0200) Subject: doc/contribute: fix typo and reword a few sentences X-Git-Tag: go1.11beta1~18 X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=291e57f057c480889be3cc7abf83698f8c6646ba;p=gostls13.git 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 --- 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 AUTHORS file.

Step 2: Configure git authentication

-Go development happens on +The main Go repository is located at go.googlesource.com, 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.

  • -Copy and run this script locally in your command line terminal to store your -secret authentication token in a .gitcookies file. +Copy and run this script locally in your terminal to store your secret +authentication token in a .gitcookies file. If you are using a Windows computer and running cmd, 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.

    Before contributing code

    -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 filing a new issue -or by claiming an existing issue. +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 filing +a new issue or by claiming +an existing one.

    Check the issue tracker

    @@ -309,13 +310,13 @@ When planning work, please note that the Go project follows a six-month development cycle. 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.

    -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 change proposal process before they can be accepted.

    @@ -337,10 +338,11 @@ GitHub pull requests to Gerrit.

    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.

    @@ -545,7 +547,7 @@ ALL TESTS PASSED

    You can use make.bash instead of all.bash -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 go tool is built, it will be installed as bin/go 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.

    -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 git codereview change:

    @@ -674,7 +677,7 @@ Don't use HTML, Markdown, or any other markup language.

    Add any relevant information, such as benchmark data if the change -afects performance. +affects performance. The benchcmp tool is conventionally used to format benchmark data for change descriptions. @@ -937,7 +940,7 @@ remote: ERROR: does not match your user account.

    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: