Contribution Guide Good commit messages

Here is an example of a good one:

math: improve Sin, Cos and Tan precision for very large arguments

The existing implementation has poor numerical properties for
large arguments, so use the McGillicutty algorithm to improve
accuracy above 1e10.

The algorithm is described at https://wikipedia.org/wiki/McGillicutty_Algorithm

Fixes #159

Here is an example of a good one:

math: improve Sin, Cos and Tan precision for very large arguments

The existing implementation has poor numerical properties for
large arguments, so use the McGillicutty algorithm to improve
accuracy above 1e10.

The algorithm is described at https://wikipedia.org/wiki/McGillicutty_Algorithm

Fixes #159

Contributing to Ruby¶ ↑ Contributing A Patch¶ ↑ Commit messages¶ ↑

When you’re ready to commit:

git commit path/to/files

Go Contribution Guide Sending a change via Gerrit Step 5: Revise changes after a review

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:

$ git codereview change     # amend current commit
(open $EDITOR)
$ git codereview mail       # send new changes to Gerrit

Go Contribution Guide Miscellaneous topics Troubleshooting mail errors

Then change the commit to use this alternative e-mail address with this command:

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

Go Contribution Guide Sending a change via Gerrit Step 2: Prepare changes in a new branch

To commit changes, instead of git commit, use git codereview change.

$ git codereview change
(open $EDITOR)

Contribution Guide Becoming a contributor Step 0: Select a Google Account

You also need to make sure that your Git tool is configured to create commits using your chosen e-mail address. You can either configure Git globally (as a default for all projects), or locally (for a single specific project). You can check the current configuration with this command:

$ git config --global user.email  # check current global config
$ git config user.email           # check current local config

Go Contribution Guide Sending a change via Gerrit Step 2: Prepare changes in a new branch

You can edit the commit description in your favorite editor as usual. The git codereview change command will automatically add a unique Change-Id line near the bottom. That line is used by Gerrit to match successive uploads of the same change. Do not edit or delete it. A Change-Id looks like this:

Change-Id: I2fbdbffb3aab626c4b6f56348861b7909e3e8990

Go Contribution Guide Miscellaneous topics Reviewing code by others

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 will look something like this:

$ git fetch https://go.googlesource.com/review refs/changes/21/13245/1 && git checkout FETCH_HEAD

Go Contribution Guide Miscellaneous topics Sending multiple dependent changes

To send out a group of dependent changes, keep each change as a different commit under the same branch, and then run:

$ git codereview mail HEAD

Go Contribution Guide Miscellaneous topics Copyright headers

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

// Copyright 2022 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.

Recommend

Go Contribution Guide Sending a change via Gerrit Step 5: Revise changes after a review

Go Contribution Guide Sending a change via Gerrit Step 4: Send changes for review

Go Contribution Guide Sending a change via Gerrit Step 3: Test your changes In the golang.org/x/... repositories

Contribution Guide Sending a change via Gerrit Step 3: Test your changes In the main Go repository

Go Contribution Guide Sending a change via Gerrit Step 2: Prepare changes in a new branch

Go Contribution Guide Sending a change via Gerrit Step 1: Clone the source code

Go Contribution Guide Sending a change via Gerrit Overview

Go Contribution Guide Becoming a contributor Step 4: Install the git-codereview command

Contribution Guide Becoming a contributor Step 0: Select a Google Account

Go Contribution Guide Becoming a contributor Overview

Go Diagnostics Debugging