chore: mention the faster code fmt approach (#1022)

* chore: mention the faster code fmt approach * chore: Add Coursier cli for formatting * chore: Remove the scalafmt version. * chore: Add notes about install scalafmt with cs. * chore: mention binaries built --------- Co-authored-by: He-Pin(kerr) <[email protected]>
apache · Jan 23, 2024 · 7ffcf5b · 7ffcf5b
1 parent d282d5e
commit 7ffcf5b
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -171,6 +171,18 @@ sbt
 applyCodeStyle
 ```
 
+To format Scala code more faster, you could format code with [Scala-CLI](https://scala-cli.virtuslab.org/) or [Coursier CLI](https://scalameta.org/scalafmt/docs/installation.html#cli):
+
+**With Scala-Cli**
+```shell
+scala-cli fmt
+```
+**With Coursier CLI**
+```Shell
+cs install scalafmt // skip it if scalafmt is already installed. If you are a macOS or Linux user, you can simply download the native binaries from the Coursier CLI installation page.
+scalafmt
+```
+
 #### Do not use `-optimize` Scala compiler flag
 
 Pekko has not been compiled or tested with `-optimize` Scala compiler flag. (In sbt, you can specify compiler options in the `scalacOptions` key.)