1
0
mirror of https://github.com/golang/go synced 2024-11-05 15:56:12 -07:00
go/README.md
Agniva De Sarker 65d5228f00 all: add a section on JS/CSS formatting to README
Updates golang/go#21719

Change-Id: I3709577f48bcbff26beb6f5b8ff8d06fb18cc619
Reviewed-on: https://go-review.googlesource.com/c/tools/+/183877
Run-TryBot: Agniva De Sarker <agniva.quicksilver@gmail.com>
TryBot-Result: Gobot Gobot <gobot@golang.org>
Reviewed-by: Andrew Bonventre <andybons@golang.org>
2020-05-28 15:31:34 +00:00

37 lines
1.3 KiB
Markdown

# Go Tools
This subrepository holds the source for various packages and tools that support
the Go programming language.
Some of the tools, `godoc` and `vet` for example, are included in binary Go
distributions.
Others, including the Go `guru` and the test coverage tool, can be fetched with
`go get`.
Packages include a type-checker for Go and an implementation of the
Static Single Assignment form (SSA) representation for Go programs.
## Download/Install
The easiest way to install is to run `go get -u golang.org/x/tools/...`. You can
also manually git clone the repository to `$GOPATH/src/golang.org/x/tools`.
## JS/CSS Formatting
This repository uses [prettier](https://prettier.io/) to format JS and CSS files.
The version of `prettier` used is 1.18.2.
It is encouraged that all JS and CSS code be run through this before submitting
a change. However, it is not a strict requirement enforced by CI.
## 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 tools repository is located at
https://github.com/golang/go/issues. Prefix your issue with "x/tools/(your
subdir):" in the subject line, so it is easy to find.