diff options
| author | Kevin Burke <kev@inburke.com> | 2017-07-18 20:36:05 -0700 |
|---|---|---|
| committer | Kevin Burke <kev@inburke.com> | 2017-09-27 05:38:32 +0000 |
| commit | 925f9bd3fb4bf9cda7fef491941894d634b3b535 (patch) | |
| tree | 31085385592a78ceefff6c1ac74e9f848e8f4387 | |
| parent | d9d84288482b14b19527db3f0a0d4b4fc5a6bbd0 (diff) | |
| download | go-x-review-925f9bd3fb4bf9cda7fef491941894d634b3b535.tar.xz | |
README: add better description
Move the README to README.md so Gerrit can render it; currently
Gerrit only renders files named exactly "README.md" (for example at
https://go.googlesource.com/go).
Add more links to the README explaining how to file issues,
how to submit code changes, where to download the code to and
how to get it. Hopefully this should help people who go to
https://go.googlesource.com/review or https://github.com/golang/review
figure out how to get started with development.
Change-Id: Ie490adc9126b759f81af2a526e9e05270d3525e6
Reviewed-on: https://go-review.googlesource.com/49871
Reviewed-by: Kevin Burke <kev@inburke.com>
| -rw-r--r-- | README | 3 | ||||
| -rw-r--r-- | README.md | 20 |
2 files changed, 20 insertions, 3 deletions
@@ -1,3 +0,0 @@ -The git-codereview tool is a command-line tool for working with Gerrit. - -See https://godoc.org/golang.org/x/review/git-codereview diff --git a/README.md b/README.md new file mode 100644 index 0000000..48a3e08 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# git-codereview + +The git-codereview tool is a command-line tool for working with Gerrit. + +## Download/Install + +The easiest way to install is to run `go get -u golang.org/x/review`. You can +also manually git clone the repository to `$GOPATH/src/golang.org/x/review`. + +The review binary itself is available at `golang.org/x/review/git-codereview`. +Run `git codereview hooks` to install Gerrit hooks for your git repository. + +## Report Issues / Send Patches + +This repository uses Gerrit for code changes. To learn how to submit changes to +this repository, see https://golang.org/doc/contribute.html. + +The main issue tracker for the review repository is located at +https://github.com/golang/go/issues. Prefix your issue with "x/review:" in the +subject line, so it is easy to find. |