From: Steve Francia Date: Thu, 9 Feb 2017 20:33:13 +0000 (-0500) Subject: doc: reorganize the contribution guidelines into a guide X-Git-Tag: go1.9beta1~1140 X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=5f3e7aa76ddc190b199e207f2347ffffbb06b05a;p=gostls13.git doc: reorganize the contribution guidelines into a guide Updates #17802 Change-Id: I65ea0f4cde973604c04051e7eb25d12e4facecd3 Reviewed-on: https://go-review.googlesource.com/36626 Reviewed-by: Ian Lance Taylor Reviewed-by: Chris Broadfoot --- diff --git a/doc/contribute.html b/doc/contribute.html index 1f8bd0fbfe..4bb58c94e6 100644 --- a/doc/contribute.html +++ b/doc/contribute.html @@ -1,14 +1,12 @@ -

Introduction

-

-This document explains how to contribute changes to the Go project. -It assumes you have followed the -installation instructions and -have written and tested your code. +The Go project welcomes all contributors. The process of contributing +to the Go project may be different than many projects you are used to. +This document is intended as a guide to help you through the contribution +process. This guide assumes you have a basic understanding of Git and Go.

@@ -20,103 +18,54 @@ see Contributing to gccgo.) Sensitive security-related issues should be reported to security@golang.org.

-

Discuss your design

- -

-The project welcomes submissions but please let everyone know what -you're working on if you want to change or add to the Go repositories. -

- -

-Before undertaking to write something new for the Go project, -please file an issue -(or claim an existing issue). -Significant changes must go through the -change proposal process -before they can be accepted. -

- -

-This process gives everyone a chance to validate the design, -helps prevent duplication of effort, -and ensures that the idea fits inside the goals for the language and tools. -It also checks that the design is sound before code is written; -the code review tool is not the place for high-level discussions. -

- -

-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 doc updates are accepted. -New work cannot be submitted during a feature freeze. -

- -

Testing redux

- -

-You've written and tested your code, but -before sending code out for review, run all the tests for the whole -tree to make sure the changes don't break other packages or programs: -

- -
-$ cd go/src
-$ ./all.bash
-
+

Becoming a contributor

-(To build under Windows use all.bat.) +Before you can contribute to the Go project you need to setup a few prerequisites. +The Go project uses Gerrit, an open +source online tool, to perform all code reviews. +Gerrit uses your email address as a unique identifier. +The Go project contributing flow is currently configured to work only with Google Accounts. +You must go through the following process prior to contributing. +You only need to do this once per Google Account.

+

Configure Git to use Gerrit

-After running for a while, the command should print -"ALL TESTS PASSED". +You'll need a web browser and a command line terminal. +You should already have Git installed.

-

Code review

-

-Changes to Go must be reviewed before they are accepted, -no matter who makes the change. -A custom git command called git-codereview, -discussed below, helps manage the code review process through a Google-hosted -instance of the code review -system called Gerrit. -

- -

Set up authentication for code review

- -

-Gerrit uses Google Accounts for authentication. If you don't have -a Google Account, you can create an account which +Gerrit uses Google Accounts for authentication. +If you don't have a Google Account, you can create an account which includes a new Gmail email account or create an account associated with your existing email address.

-

-The email address associated with the Google Account you use will be recorded in -the change log -and in the contributors file. -

+

Step 1: Sign in to googlesource and generate a password

-To set up your account in Gerrit, visit -go.googlesource.com +Visit go.googlesource.com and click on "Generate Password" in the page's top right menu bar. +You will be redirected to accounts.google.com to sign in.

+

Step 2: Run the provided script

-You will be redirected to accounts.google.com to sign in. +After signing in, you are taken to a page on go.googlesource.com with the title "Configure Git". +This page contains a personalized script which when run locally will configure git +to have your unique authentication key. +This key is paired with one generated server side similar to how ssh keys work.

-Once signed in, you are returned back to go.googlesource.com to "Configure Git". -Follow the instructions on the page. -(If you are on a Windows computer, you should instead follow the instructions -in the yellow box to run the command.) +Copy and run this script locally in your command line terminal. +(On a Windows computer using cmd you should instead follow the instructions +in the yellow box to run the command. If you are using git-bash use the same +script as *nix.)

@@ -124,23 +73,25 @@ Your secret authentication token is now in a .gitcookie file and Git is configured to use this file.

-

Register with Gerrit

+

Step 3: Register with Gerrit

-Now that you have your authentication token, -you need to register your account with Gerrit. -To do this, visit - -go-review.googlesource.com/login/. You will immediately be redirected -to Google Accounts. Sign in using the same Google Account you used above. -That is all that is required. +Now that you have your authentication token, you need to register your +account with Gerrit. +To do this, visit +go-review.googlesource.com/login/. +Sign in using the same Google Account you used above.

-

Contributor License Agreement

+

Contributor License Agreement

+ +

Which CLA

+

+Before sending your first change to the Go project +you must have completed one of the following two CLAs. +Which CLA you should sign depends on who owns the copyright to your work. +

-

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, -you must have completed one of the contributor license agreements:

  • If you are the copyright holder, you will need to agree to the @@ -151,37 +102,49 @@ contributor license agreement, which can be completed online. If your organization is the copyright holder, the organization will need to agree to the corporate -contributor license agreement. -(If the copyright holder for your code has already completed the -agreement in connection with another Google open source project, -it does not need to be completed again.) +contributor license agreement.

-You can use the links above to create and sign the contributor license agreement -or you can show your current agreements and create new ones through the Gerrit -interface. Log into Gerrit, +If the copyright holder for your contribution has already completed the +agreement in connection with another Google open source project, +it does not need to be completed again. +

+ +

Completing the CLA

+ +

+You can see your currently signed agreements and sign new ones through the Gerrit +interface. +To do this, Log into Gerrit, click your name in the upper-right, choose "Settings", then select "Agreements" -from the topics on the left. If you do not have a signed agreement listed here, +from the topics on the left. +If you do not have a signed agreement listed here, you can create one by clicking "New Contributor Agreement" and following the steps.

-This rigmarole only needs to be done for your first submission for each email address. +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 golang-dev and let us know, so that we can make sure an appropriate agreement is +completed and update the AUTHORS file.

+ +

Preparing a Development Environment for Contributing

+ +

Setting up Git for submission to Gerrit

-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 AUTHORS file. +Changes to Go must be reviewed before they are accepted, no matter who makes the change. +A custom git command called git-codereview, discussed below, +helps manage the code review process through a Google-hosted +instance Gerrit.

-

Install the git-codereview command

- +

Install the git-codereview command

-Now install the git-codereview command by running, +Install the git-codereview command by running, 

@@ -201,19 +164,29 @@ $ git codereview help
 prints help text, not an error.
 

 
+

+On Windows, when using git-bash you must make sure that
+git-codereview.exe is in your git exec-path.
+Run git --exec-path to discover the right location then create a
+symbolic link or simply copy the executible from $GOPATH/bin to this directory.
+

+
 

 Note to Git aficionados:
 The git-codereview command is not required to
-upload and manage Gerrit code reviews. For those who prefer plain Git, the text
-below gives the Git equivalent of each git-codereview command.
+upload and manage Gerrit code reviews.
+For those who prefer plain Git, the text below gives the Git equivalent of
+each git-codereview command.
 

 
-
If you do use plain
-Git, note that you still need the commit hooks that the git-codereview command
-configures; those hooks add a Gerrit Change-Id line to the commit
-message and check that all Go source files have been formatted with gofmt. Even
-if you intend to use plain Git for daily work, install the hooks in a new Git
-checkout by running git-codereview hooks.
+

+If you do use plain Git, note that you still need the commit hooks that the
+git-codereview command configures; those hooks add a Gerrit
+Change-Id line to the commit message and check that all Go source
+files have been formatted with gofmt.
+Even if you intend to use plain Git for
+daily work, install the hooks in a new Git checkout by running
+git-codereview hooks.
 

 
 

@@ -264,7 +237,8 @@ To install them, copy this text into your Git configuration file
 	sync = codereview sync
-

Understanding the git-codereview command

+ +

Understanding the git-codereview command

After installing the git-codereview command, you can run

@@ -277,11 +251,70 @@ to learn more about its commands. You can also read the command documentation.

-

Switch to the master branch

+ +

Making a Contribution

+ +

Discuss your design

+ +

+The project welcomes submissions but please let everyone know what +you're working on if you want to change or add to the Go repositories. +

+ +

+Before undertaking to write something new for the Go project, +please file an issue +(or claim an existing issue). +Significant changes must go through the +change proposal process +before they can be accepted. +

+ +

+This process gives everyone a chance to validate the design, +helps prevent duplication of effort, +and ensures that the idea fits inside the goals for the language and tools. +It also checks that the design is sound before code is written; +the code review tool is not the place for high-level discussions. +

+ +

+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 doc updates are accepted. New contributions can be +sent during a feature freeze but will not be accepted until the freeze thaws. +

+ +

Making a change

+ +

Getting Go Source

+

+First you need to have a local copy of the source checked out from the correct +repository. +As Go builds Go you will also likely need to have a working version +of Go installed (some documentation changes may not need this). +This should be a recent version of Go and can be obtained via any package or +binary distribution or you can build it from source. +

+ +

+You should checkout the Go source repo anywhere you want as long as it's +outside of your $GOPATH. +Go to a directory where you want the source to appear and run the following +command in a terminal. +

+ +

+$ git clone https://go.googlesource.com/go
+$ cd go
+
+ +

Contributing to the main Go tree

Most Go installations use a release branch, but new changes should -only be made based on the master branch. +only be made based on the master branch.
(They may be applied later to a release branch as part of the release process, but most contributors won't do this themselves.) Before making a change, make sure you start on the master branch: @@ -297,10 +330,61 @@ $ git sync git pull -r.)

-

Make a change

+

Contributing to subrepositories (golang.org/x/...)

+ +

+If you are contributing a change to a subrepository, obtain the +Go package using go get. For example, to contribute +to golang.org/x/oauth2, check out the code by running: +

+ +
+$ go get -d golang.org/x/oauth2/...
+
+ +

+Then, change your directory to the package's source directory +($GOPATH/src/golang.org/x/oauth2). +

+ +

Make your changes

+ +

+The entire checked-out tree is editable. +Make your changes as you see fit ensuring that you create appropriate +tests along with your changes. Test your changes as you go. +

+ + + +

+Files in the Go repository don't list author names, both to avoid clutter +and to avoid having to keep the lists up to date. +Instead, your name will appear in the +change log and in the CONTRIBUTORS file and perhaps the AUTHORS file. +These files are automatically generated from the commit logs perodically. +The AUTHORS file defines who “The Go +Authors”—the copyright holders—are. +

+ +

New files that you contribute should use the standard copyright header:

+ +
+// Copyright 2017 The Go Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+ +

+Files in the repository are copyright the year they are added. +Do not update the copyright year on files that you change. +

+ +

Commit your changes

-The entire checked-out tree is writable. Once you have edited files, you must tell Git that they have been modified. You must also tell Git about any files that are added, removed, or renamed files. These operations are done with the usual Git commands, @@ -311,16 +395,19 @@ and

-If you wish to checkpoint your work, or are ready to send the code out for review, run

+Once you have the changes queued up, you will want to commit them. +In the Go contribution workflow this is done with a `git change` command, +which creates a local branch and commits the changes directly to that local branch. +

 $ git change <branch>

-from any directory in your Go repository to commit the changes so far. The name <branch> is an arbitrary one you choose to identify the -local branch containing your changes. +local branch containing your changes and will not be used elsewhere. +This is an offline operation and nothing will be sent to the server yet.

@@ -331,9 +418,11 @@ then git commit.)

-Git will open a change description file in your editor. +As the `git commit` is the final step, Git will open an editor to ask for a +commit message. (It uses the editor named by the $EDITOR environment variable, vi by default.) + The file will look like:

@@ -352,7 +441,7 @@ At the beginning of this file is a blank line; replace it with a thorough description of your change. The first line of the change description is conventionally a one-line summary of the change, prefixed by the primary affected package, -and is used as the subject for code review mail. +and is used as the subject for code review email. It should complete the sentence "This change modifies Go to _____." The rest of the description elaborates and should provide context for the change and explain what it does. @@ -395,7 +484,7 @@ the command and move that file to a different branch.

The special notation "Fixes #159" associates the change with issue 159 in the Go issue tracker. -When this change is eventually submitted, the issue +When this change is eventually applied, the issue tracker will automatically mark the issue as fixed. (There are several such conventions, described in detail in the GitHub Issue Tracker documentation.) @@ -406,6 +495,13 @@ Once you have finished writing the commit message, save the file and exit the editor.

+

+You must have the $EDITOR environment variable set properly and working properly (exiting cleanly) +for this operation to succeed. +If you run into any issues at this step, it's likely your editor isn't exiting cleanly. +Try setting a different editor in your $EDITOR environment variable. +

+

If you wish to do more editing, re-stage your changes using git add, and then run @@ -416,8 +512,8 @@ $ git change

-to update the change description and incorporate the staged changes. The -change description contains a Change-Id line near the bottom, +to update the change description and incorporate the staged changes. +The change description contains a Change-Id line near the bottom, added by a Git commit hook during the initial git change. That line is used by Gerrit to match successive uploads of the same change. @@ -429,35 +525,44 @@ Do not edit or delete it. runs git commit --amend.)

-

Mail the change for review

+

Testing

-Once the change is ready, mail it out for review: +You've written and tested your code, but +before sending code out for review, run all the tests for the whole +tree to make sure the changes don't break other packages or programs: 

-$ git mail
+$ cd go/src
+$ ./all.bash

-You can specify a reviewer or CC interested parties -using the -r or -cc options. -Both accept a comma-separated list of email addresses: +(To build under Windows use all.bat.) +

+ +

+After running for a while, the command should print 

-$ git mail -r joe@golang.org -cc mabel@example.com,math-nuts@swtch.com
+"ALL TESTS PASSED".
+

Send the change for review

+

-Unless explicitly told otherwise, such as in the discussion leading -up to sending in the change list, it's better not to specify a reviewer. -All changes are automatically CC'ed to the -golang-codereviews@googlegroups.com -mailing list. If this is your first ever change, there may be a moderation -delay before it appears on the mailing list, to prevent spam. +Once the change is ready, send it for review. +This is similar to a git push in a GitHub style workflow. +This is done via the mail alias setup earlier which despite its name, doesn't +directly mail anything, it simply sends the change to Gerrit via git push.

+
+$ git mail
+
+

(In Git terms, git mail pushes the local committed changes to Gerrit using git push origin @@ -479,7 +584,76 @@ remote: New Changes: remote: https://go-review.googlesource.com/99999 math: improved Sin, Cos and Tan precision for very large arguments -

Reviewing code

+

Troubleshooting

+ +

+The most common way that the git mail command fails is because the +email address used has not gone through the setup above. +
+If you see something like... +

+ +
+remote: Processing changes: refs: 1, done
+remote:
+remote: ERROR:  In commit ab13517fa29487dcf8b0d48916c51639426c5ee9
+remote: ERROR:  author email address XXXXXXXXXXXXXXXXXXX
+remote: ERROR:  does not match your user account.
+
+ +

+You need to either add the email address listed to the CLA or set this repo to use +another email address already approved. +

+ +

+First let's change the email address for this repo so this doesn't happen again. +You can change your email address for this repo with the following command: +

+ +
+$ git config user.email email@address.com
+
+ +

+Then change the previous commit to use this alternative email address. +You can do that with: +

+ +
+$ git commit --amend --author="Author Name <email@address.com>"
+
+ +

+Finally try to resend with: +

+ +
+$ git mail
+
+ +

Specifying a reviewer / CCing others

+ +

+Unless explicitly told otherwise, such as in the discussion leading +up to sending in the change list, it's better not to specify a reviewer. +All changes are automatically CC'ed to the +golang-codereviews@googlegroups.com +mailing list. If this is your first ever change, there may be a moderation +delay before it appears on the mailing list, to prevent spam. +

+ +

+You can specify a reviewer or CC interested parties +using the -r or -cc options. +Both accept a comma-separated list of email addresses: +

+ +
+$ git mail -r joe@golang.org -cc mabel@example.com,math-nuts@swtch.com
+
+ +

Going through the review process

Running git mail will send an email to you and the @@ -491,7 +665,15 @@ You must reply through the web interface. (Unlike with the old Rietveld review system, replying by mail has no effect.)

-

Revise and upload

+

Revise and resend

+ +

+The Go contribution workflow is optimized for iterative revisions based on +feedback. +It is rare that an initial contribution will be ready to be applied as is. +As you revise your contribution and resend Gerrit will retain a history of +all the changes and comments made in the single URL. +

You must respond to review comments through the web interface. @@ -534,6 +716,8 @@ $ git sync git pull -r.)

+

Resolving Conflicts

+

If files you were editing have changed, Git does its best to merge the remote changes into your local changes. @@ -609,8 +793,8 @@ might turn up:

Git doesn't show it, but suppose the original text that both edits started with was 1e8; you changed it to 1e10 and the other change to 1e9, -so the correct answer might now be 1e10. First, edit the section -to remove the markers and leave the correct code: +so the correct answer might now be 1e10. +First, edit the section to remove the markers and leave the correct code: 

@@ -639,10 +823,13 @@ restore the change commit.
 
Reviewing code by others

 
 

-You can import a change proposed by someone else into your local Git repository.
+As part of the review process reviewers can propose changes directly (in the
+GitHub workflow this would be someone else attaching commits to a pull request).
+
+You can import these changes proposed by someone else into your local Git repository.
 On the Gerrit review page, click the "Download ▼" link in the upper right
-corner, copy the "Checkout" command and run it from your local Git repo.
-It should look something like this:
+corner, copy the "Checkout" command and run it from your local Git repo. It
+should look something like this:
 

 
 
@@ -653,11 +840,11 @@ $ git fetch https://go.googlesource.com/review refs/changes/21/1221/1 &&
 To revert, change back to the branch you were working in.
 

 
-
Submit the change after the review

+
Apply the change to the master branch

 
 

 After the code has been LGTM'ed, an approver may
-submit it to the master branch using the Gerrit UI.
+apply it to the master branch using the Gerrit UI.
 There is a "Submit" button on the web page for the change
 that appears once the change is approved (marked +2).
 

@@ -669,41 +856,13 @@ and the code review will be updated with a link to the change
 in the repository.
 Since the method used to integrate the changes is "Cherry Pick",
 the commit hashes in the repository will be changed by
-the submit operation.
+the "Submit" operation.
 

 
-
More information

+
More information

 
 

-In addition to the information here, the Go community maintains a CodeReview wiki page.
+In addition to the information here, the Go community maintains a CodeReview wiki page.
 Feel free to contribute to this page as you learn the review process.
 

-
-
-
-
Files in the Go repository don't list author names,
-both to avoid clutter and to avoid having to keep the lists up to date.
-Instead, your name will appear in the
-change log
-and in the CONTRIBUTORS file
-and perhaps the AUTHORS file.
-

-
-
The CONTRIBUTORS file
-defines who the Go contributors—the people—are;
-the AUTHORS file defines
-who “The Go Authors”—the copyright holders—are.
-These files will be periodically updated based on the commit logs.
-
-
Code that you contribute should use the standard copyright header:

-
-
-// Copyright 2017 The Go Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style
-// license that can be found in the LICENSE file.
-

-
-

-Files in the repository are copyright the year they are added. It is not
-necessary to update the copyright year on files that you change.
-