raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 10

Add more comments about formatting. (#29001)

Browse source
This commit is contained in:
kerr 2021-01-18 20:03:22 +08:00 • committed by GitHub
parent c83b57674f
commit 01ad4620ec
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

29
CONTRIBUTING.md
View file

@ -169,6 +169,33 @@ akka-cluster/scalafmtAll
akka-persistence/scalafmtAll akka-persistence/scalafmtAll
``` ```
To format the Java source code:
```
sbt
project akka-actor
javafmtAll
```
To keep the *import*s sorted with:
```
sbt
project akka-actor
sortImports
```
To verify code style with:
```
sbt
verifyCodeStyle
```
To apply code style with:
```
sbt
applyCodeStyle
```
### Do not use `-optimize` Scala compiler flag ### Do not use `-optimize` Scala compiler flag
Akka has not been compiled or tested with `-optimize` Scala compiler flag. (In sbt, you can specify compiler options in the `scalacOptions` key.) Akka has not been compiled or tested with `-optimize` Scala compiler flag. (In sbt, you can specify compiler options in the `scalacOptions` key.)
@ -430,6 +457,8 @@ not needed to use `sbt scalafmtAll` when editing with IntelliJ.
PR validation includes checking that the Scala sources are formatted and will fail if they are not. PR validation includes checking that the Scala sources are formatted and will fail if they are not.
It's recommended to run `sbt +sortImports` to keep the *import*s sorted.
### Java style ### Java style
Akka uses [the sbt Java Formatter plugin](https://github.com/sbt/sbt-java-formatter) to format Java sources. Akka uses [the sbt Java Formatter plugin](https://github.com/sbt/sbt-java-formatter) to format Java sources.