README

Scratch Repository

This repository is mainly for use by people learning how to use Gerrit and contribute to Go.

Click here for a tutorial on how to get started with a contribution to this repository.

A fuller, text-based tutorial based around the core Go project can be found here.

What should I add?

Add a folder with your username, and put a main function in there. You can put whatever you want in your main function; see the existing directories for examples.

All files should have the standard licensing header, and add appropriate documentation see the other files in this repository for an example.

Notes about Gerrit

If you have needed to change a Github pull request, you probably just added a second commit with the requested changes and pushed it. By contrast, all changes opened in Gerrit are a single commit, which means you need to amend your commit if the reviewer requests feedback.

To amend a previous commit, run git add (list of files you changed) to add your changes, then run git commit --amend to amend the commit to add new data. Your commit message should still summarize the entire commit ("Add kevinburke/main.go"), not just the change a reviewer asked for ("Fix typo").

After you amend the commit, re-run git codereview mail to push that change to the server. Then in the Gerrit UI, find the in-line comments left by your reviewer, click "Done", go back to the main PR page, and click "Reply" => "Send" to tell your reviewer that you've addressed your feedback.

Once you get a "Code-Review: +2" from a Go contributor, your change will be merged!

Need help?

Gerrit is not easy to get started with, and we want to help you out. If you are having trouble with Gerrit, contact the golang-devexp mailing list for help!

Expand ▾ Collapse ▴

Documentation

Overview

    Package scratch exists mainly for people to learn how to use Gerrit and contribute to Go.

    Read the README.md to access the tutorial.

    Source Files

    Directories

    Path Synopsis
    Ch3ck command states its opinion on containers.
    Ch3ck command states its opinion on containers.
    The aschlesener command prints something amazing.
    The aschlesener command prints something amazing.
    Testing go contrib at gophercon! This file is a "Hello, World" for code review
    Testing go contrib at gophercon! This file is a "Hello, World" for code review
    The cmcguinness tool displays a random number.
    The cmcguinness tool displays a random number.
    Package main has the main code of the example for contributing to go, in the gophercon
    Package main has the main code of the example for contributing to go, in the gophercon
    The main package states how awesome Deepali is.
    The main package states how awesome Deepali is.
    This tool proclaims the ruliness of tools.
    This tool proclaims the ruliness of tools.
    dtimm command hosts a friendly message on port :8080.
    dtimm command hosts a friendly message on port :8080.
    emasatsugu prints the author's username.
    emasatsugu prints the author's username.
    The fuzz program is a simple scratch program for review purposes
    The fuzz program is a simple scratch program for review purposes
    Command ghoil just prints a message.
    Command ghoil just prints a message.
    ianzapolsky is a simple hello world program for review purposes.
    ianzapolsky is a simple hello world program for review purposes.
    The jhewes program prints an amazing message.
    The jhewes program prints an amazing message.
    Prints Leigh's views on the world tw: @capileigh / gh: stealthybox
    Prints Leigh's views on the world tw: @capileigh / gh: stealthybox
    The light program prints an encouraging Go mantra.
    The light program prints an encouraging Go mantra.
    This tool proclaims the ruliness of tools.
    This tool proclaims the ruliness of tools.
    The mmcloughlin command trolls America.
    The mmcloughlin command trolls America.
    Package main is used to print a welcome message
    Package main is used to print a welcome message
    This package contains a contribution for the scratch repository.
    This package contains a contribution for the scratch repository.
    r
    The rautelap tool prints a quote from a famous bending unit.
    The rautelap tool prints a quote from a famous bending unit.
    This package greets all of the fellow gophers.
    This package greets all of the fellow gophers.
    The rogersimms command is optimistic about Linux on the desktop.
    The rogersimms command is optimistic about Linux on the desktop.
    The sselph command says hello to everyone at gophercon.
    The sselph command says hello to everyone at gophercon.
    The vickiniu command says hello!
    The vickiniu command says hello!
    This tool asserts the existence of the Proud Nation of Peru.
    This tool asserts the existence of the Proud Nation of Peru.
    The waltzofpearls program that prints "hello!" to the console.
    The waltzofpearls program that prints "hello!" to the console.
    This package is a playground for contribution best practices
    This package is a playground for contribution best practices