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 <[email protected]> TryBot-Result: Gobot Gobot <[email protected]> Reviewed-by: Andrew Bonventre <[email protected]>
daveset · May 28, 2020 · 65d5228 · 65d5228
1 parent 8e7acdb
commit 65d5228
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "trailingComma": "es5"
+}
diff --git a/README.md b/README.md
@@ -17,6 +17,15 @@ Static Single Assignment form (SSA) representation for Go programs.
 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