Giant blob of minor changes
[dotfiles/.git] / .config / coc / extensions / coc-go-data / tools / pkg / mod / golang.org / x / tools@v0.0.0-20201028153306-37f0764111ff / README.md
diff --git a/.config/coc/extensions/coc-go-data/tools/pkg/mod/golang.org/x/tools@v0.0.0-20201028153306-37f0764111ff/README.md b/.config/coc/extensions/coc-go-data/tools/pkg/mod/golang.org/x/tools@v0.0.0-20201028153306-37f0764111ff/README.md
new file mode 100644 (file)
index 0000000..8e7f941
--- /dev/null
@@ -0,0 +1,36 @@
+# 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.