]> Cypherpunks repositories - gostls13.git/commitdiff
doc: add go-contrib-init mention to contributing docs
authorBrad Fitzpatrick <bradfitz@golang.org>
Tue, 13 Jun 2017 22:50:35 +0000 (22:50 +0000)
committerBrad Fitzpatrick <bradfitz@golang.org>
Wed, 14 Jun 2017 17:03:28 +0000 (17:03 +0000)
Fixes #17802

Change-Id: I245552534c3e21d95c569ac7118ba289244ba11d
Reviewed-on: https://go-review.googlesource.com/45652
Reviewed-by: Steve Francia <spf@golang.org>
doc/contribute.html

index 753aefaa29ec69ce32963582686f9337d2699b75..e3f69580dd7a3130156fe3b81046a280b9b07fcf 100644 (file)
@@ -30,6 +30,25 @@ You must go through the following process <em>prior to contributing</em>.
 You only need to do this once per Google Account.
 </p>
 
+<h2 id="go-contrib-init">Automatically set up &amp; diagnose your development environment</h3>
+<p>
+  The <code>go-contrib-init</code> tool configures and debugs your Go
+  development environment, automatically performing many of the steps
+  on this page, or telling you what you need to do next. If you wish
+  to use it, run:
+</p>
+
+<pre>
+$ go get -u golang.org/x/tools/cmd/go-contrib-init
+$ cd /code/to/edit
+$ go-contrib-init
+</pre>
+
+<p>
+  The tool will either set things up, tell you that everything is
+  configured, or tell you what steps you need to do manually.
+</p>
+
 <h2 id="auth">Configure Git to use Gerrit</h2>
 <p>
 You'll need a web browser and a command line terminal.