You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+5-13Lines changed: 5 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,18 +73,10 @@ You might as well use any other profiler, but using https://github.com/jvm-profi
73
73
74
74
### Code quality
75
75
76
-
Before committing, don't forget to type
77
-
```shell
78
-
sbt scalafmtAll scalafixAll scalafmtSbt
79
-
```
80
-
to format the code, .sbt files and check imports. Run this command in the following directories:
81
-
- the base directory (`.`)
82
-
-`examples/akka-cluster-app`
83
-
-`examples/akka-persistence-app`
84
-
-`examples/event-migration`
85
-
You can use `pre-commit` hook, provided in `./pre-commit`, to do the formatting and checking automatically.
76
+
Don't forget to run `./scripts/format-code` before opening a pull request.
77
+
You can symlink this file as git `pre-commit` hook, but beware that it runs quite long.
86
78
87
-
Additionally, all warnings locally are escalated to errors in CI, so make sure there are none.
79
+
All local Scala compilation warnings are escalated to errors in CI, so make sure there are none.
88
80
89
81
### Compatible JDK versions
90
82
@@ -118,7 +110,7 @@ The tagged commit is then released to Maven Central.
118
110
119
111
Note that we are using an [early semantic versioning scheme](https://www.scala-lang.org/blog/2021/02/16/preventing-version-conflicts-with-versionscheme.html#early-semver-and-sbt-version-policy).
120
112
121
-
### Github Releases
113
+
### GitHub Releases
122
114
123
-
Github Releases are done automatically - with settings defined in the [publish-release-config](.github/publish-release-config.yml) file.
115
+
GitHub Releases are done automatically - with settings defined in the [publish-release-config](.github/publish-release-config.yml) file.
124
116
Release is published when a new `vX.Y.Z` git tag is pushed.
0 commit comments