From 31fdd26c6b89e0073fc1bf13a53dd72c61739d95 Mon Sep 17 00:00:00 2001 From: Julie Qiu Date: Thu, 11 Jun 2020 13:08:32 -0400 Subject: [PATCH] CONTRIBUTING.md: add guidelines for sending a CL Change-Id: Ic5d32b855beaea237c23a1f0838227a5f415bded Reviewed-on: https://team-review.git.corp.google.com/c/golang/discovery/+/768315 Reviewed-by: Jonathan Amsterdam --- CONTRIBUTING.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3d1061c9..569d03b0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -42,6 +42,14 @@ There are two ways to run pkg.go.dev locally. See [doc/frontend.md](doc/frontend.md) for details. +## Before sending a CL for review + +1. Run `./all.bash` and fix all resulting errors. See + [doc/precommit.md](doc/precommit.md) for instructions on setting up a + pre-commit hook. +2. Ensure your commit message is formatted according to + [Go conventions](http://golang.org/wiki/CommitMessage). + ## Questions You can find us in the #tools channel on the Gophers Slack.